docFragment (Type de variable)

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

Version :

Accueil | Connexion | Français

Propriétés spécifiques à la description des variables de type docFragment
Fonctions WLangage utilisant les variables de type docFragment

WINDEV

WEBDEV

WINDEV Mobile

Autres

Voir Aussi

docFragment (Type de variable)

En anglais : docFragment

Le type docFragment permet de définir toutes les caractéristiques d'un fragment d’un document "docx". Les caractéristiques de ce fragment peuvent être définies et modifiées à l'aide de différentes propriétés WLangage.

Un fragment est défini par ses positions de début et de fin. Il peut donc :

s'étendre sur plusieurs paragraphes,
commencer au milieu d'un mot quelconque,
se terminer au milieu d'un mot quelconque.

Remarque : Pour plus de détails sur la déclaration de ce type de variable et l'utilisation des propriétés WLangage, consultez Déclaration d'une variable.

Exemple

// Changement de la couleur de la sélection
// Récupération de la sélection actuelle
MaSélection est un docFragment(TT_MonDocument, TT_MonDocument..Curseur, ...
TT_MonDocument..LongueurSélection)
// Changement de la couleur
MaSélection..Style..CouleurTexte = RougePastel

// Chargement du document
MonDoc est un Document = "c:\temp\doc.docx"

// Ajoute du texte à la fin du document
FragmentFin est un docFragment(MonDoc, -1 , 0)
FragmentFin..Texte += "Fin de document"

Syntaxe

Déclarer un fragment d'un document non décrit Masquer les détails

MaVariable est une docFragment

Dans ce cas, le fragment du document n'est pas décrit. La variable devra être affectée avec un fragment existant ou avec le résultat d'une des fonctions de manipulations de documents (par exemple avec la fonction DocRecherche).

Déclarer et décrire un fragment Masquer les détails

MaVariable est un docFragment([<Document> [, <Début du fragment> [, <Longueur>]]])

<Document> : Variable optionnelle de type Document ou chaîne de caractères (avec ou sans guillemets)

Document dans lequel l'extraction d'un fragment doit être effectuée. Ce document correspond :
au nom d'un champ Traitement de texte.
à une variable de type Document.

<Début du fragment> : Entier optionnel

Position du début du fragment du document à manipuler. Cette position est donnée en nombre de caractères :
depuis le début du document (nombre positif).
depuis la fin du document (nombre négatif).

<Longueur> : Entier optionnel

Longueur du fragment à manipuler, exprimée en nombre de caractères.
Remarque : un nombre négatif permet de prendre un nombre de caractères depuis la fin : '-1' = jusqu'à la fin, '-2' = jusqu'à 1 caractère avant la fin, etc.

Remarques

Propriétés spécifiques à la description des variables de type docFragment

Les propriétés suivantes peuvent être utilisées pour manipuler une variable de type docFragment :


Nom de la propriété		Type manipulé	Effet
Elément		Tableau de docElément	Eléments composant le fragment du document manipulé. Il est possible de parcourir les éléments du fragment via l'instruction POUR TOUT.
Mot		Tableau de docFragment	Mots composant le fragment du document manipulé. Il est possible de parcourir les mots du fragment via l'instruction POUR TOUT.
Paragraphe		Tableau de docParagraphe	Paragraphes concernés par le fragment (cas où un fragment est composé de plusieurs paragraphes). Il est possible de parcourir les paragraphes via l'instruction POUR TOUT.
PositionDébut		Entier	Position du début du fragment. Cette position est relative au document entier.
PositionFin		Entier	Position de fin du fragment. Cette position est relative au document entier.
Style			Informations des styles combinés de tous les éléments composant le fragment du document manipulé.
	Style..AlignementVertical	Constante de type Entier	Parangonnage du texte : alignementBaseline : Le texte est positionné sur la ligne de base. alignementExposant : Le texte est positionné en exposant. alignementIndice : Le texte est positionné en indice.
	Style..CouleurSouligné	Entier	Couleur utilisée pour souligner le texte. Cette couleur peut correspondre à : une couleur RVB (obtenue avec la fonction RVB). une couleur TSL (obtenue avec la fonction TSL), une couleur prédéfinie dans le WLangage.
	Style..CouleurSurlignage	Entier	Couleur utilisée pour surligner le texte. Seules les couleurs suivantes sont disponibles : Transparent Noir BleuClair CyanClair VertClair MagentaClair RougeClair JauneClair Blanc BleuFoncé CyanFoncé VertFoncé MagentaFoncé RougeFoncé JauneFoncé GrisClair GrisFoncé
	Style..CouleurTexte	Entier	Couleur du texte. Cette couleur peut correspondre à : une couleur RVB (obtenue avec la fonction RVB). une couleur TSL (obtenue avec la fonction TSL), une couleur prédéfinie dans le WLangage.
	Style..PoliceBarrée	Entier	0 : Police non barrée 1 : Police barrée 2 : Indéfini
	Style..PoliceGras	Entier	0 : Police non gras 1 : Police gras 2 : Indéfini
	Style..PoliceItalique	Entier	0 : Police non italique 1 : Police italique 2 : Indéfini
	Style..PoliceNom	Chaîne de caractères	Nom de la police utilisée pour le fragment.
	Style..PoliceSoulignée	Constante de type Entier	Type de soulignement : soulignéAucun : Aucun soulignement soulignéDouble : Soulignement double soulignéEpais : Soulignement épais soulignéMots : Soulignement des mots uniquement soulignéPointillés : Soulignement en pointillés soulignéPointillésEpais : Soulignement en pointillés épais soulignéPointPointTiret : Soulignement avec des points et des tirets soulignéPointPointTiretEpais : Soulignement avec des points et des tirets épais soulignéPointTiret : Soulignement avec des tirets soulignéPointTiretEpais : Soulignement avec des tirets épais soulignéSimple : Soulignement simple soulignéTiret : Soulignement avec des tirets soulignéTiretEpais : Soulignement avec des tirets épais
	Style..PoliceTaille	Réel	Taille de la police.
Texte		Chaîne de caractères	Texte brut correspondant au contenu du fragment manipulé.


Nom de la propriété		Type manipulé	Effet
Elément		Tableau de docElément	Eléments composant le fragment du document manipulé. Il est possible de parcourir les éléments du fragment via l'instruction POUR TOUT.
Versions 24 et supérieures Etendue Nouveauté 24 Etendue Etendue		Entier	Nombre de caractères contenus dans le fragment. Correspond à la position de fin moins la position de début. L'étendue peut correspondre à une valeur positive, négative ou nulle. Remarques : Si le fragment contient un tableau ou un morceau de tableau, tous les caractères du tableau ou du morceau de tableau sont comptés. Si le fragment contient une image ou une zone de texte, l'image et la zone de texte correspondent chacun à 1 caractère.
IdentifiantSousDocument		Entier	Identifiant correspondant au sous-document associé au fragment. Cette propriété est d'un usage avancé. Attention : Cette propriété est disponible uniquement à partir de la version 220071.
LangueOrthographe		Chaîne de caractères	Langue du fragment. La notation utilisée correspond à la norme 639-1. Par exemple "FR-fr". En lecture, cette propriété renvoie une information valide uniquement si le fragment correspond à une seule langue. Remarque : Pour réaliser la correction orthographique correspondant à la langue du fragment, il est nécessaire de charger le dictionnaire de cette langue avec la fonction DictionnaireCharge. Cette propriété est disponible uniquement à partir de la version 220059U (module du 17/05/2017).
MiseEnForme		Variable de type docMiseEnForme	Informations de mise en forme de tous les éléments composant le fragment du document manipulé. Attention : A partir de WINDEV version 220052s (module de mise à jour du champ Traitement de Texte applicable sur WINDEV Update 1), la propriété "..Style" s'appelle désormais "..MiseEnForme".
MiseEnPage			Mise en page du fragment en cours. Attention : Cette propriété est disponible uniquement à partir de la version 220071.
	MiseEnPage..CouleurFond	Entier	Couleur de fond du fragment. Cette couleur peut correspondre à : une couleur RVB (obtenue avec la fonction RVB), une couleur prédéfinie.
	MiseEnPage..TrameFond	Variable de type Fond	Caractéristiques de fond du fragment.
Mot		Tableau de docFragment	Mots composant le fragment du document manipulé. Il est possible de parcourir les mots du fragment via l'instruction POUR TOUT.
Paragraphe		Tableau de docParagraphe	Paragraphes concernés par le fragment (cas où un fragment est composé de plusieurs paragraphes). Il est possible de parcourir les paragraphes via l'instruction POUR TOUT.
PositionDébut		Entier	Position du début du fragment. Cette position est relative au document entier.
PositionFin		Entier	Position de fin du fragment. Cette position est relative au document entier.
StyleID		Chaîne de caractères	Identifiant du style appliqué au fragment. Cet identifiant doit exister parmi les styles liés au document. Remarque : le changement de style d'un paragraphe ou d'un fragment applique automatiquement le style paragraphe et le style caractère liés s'ils existent.
Texte		Chaîne de caractères	Texte brut correspondant au contenu du fragment manipulé.
TypeSousDocument		Constante de type Entier	Partie du document auquel le fragment appartient. Attention : Cette propriété est disponible uniquement à partir de la version 220071. Les valeurs possibles sont les suivantes : Versions 23 et supérieures typeSousDocCanvas : Conteneur d'images. Nouveauté 23 typeSousDocCanvas : Conteneur d'images. typeSousDocCanvas : Conteneur d'images. typeSousDocCorps : Corps du document. typeSousDocEnTêtePageImpaire : Entête de page impaire. typeSousDocEnTêtePagePaire : Entête de page paire. typeSousDocEnTêtePremièrePage : Entête de la première page. typeSousDocPiedDePageImpaire : Pied de page impaire. typeSousDocPiedDePagePaire : Pied de page paire. typeSousDocPiedDePremièrePage : Pied de page de la première page. Versions 23 et supérieures typeSousDocZoneDeTexte : Zone de texte. Nouveauté 23 typeSousDocZoneDeTexte : Zone de texte. typeSousDocZoneDeTexte : Zone de texte. Cette propriété est disponible en lecture uniquement.

Remarque : Ces propriétés peuvent être utilisées en utilisant une des deux syntaxes suivantes :

<Nom de la variable>..<Nom de la propriété>
<Nom de la variable>.<Nom de la propriété>

Fonctions WLangage utilisant les variables de type docFragment

Les variables de type docFrament sont manipulées par plusieurs fonctions WLangage :

fonctions WLangage utilisant une syntaxe classique :


Versions 22 et supérieures DocAjoute Nouveauté 22 DocAjoute DocAjoute	Ajoute : à la fin d'un document de type Traitement de texte : un élément, un document, un paragraphe, un texte, une image ou un fragment. à la fin d'un fragment : un élément, un texte ou une image.
Versions 22 et supérieures DocInsère Nouveauté 22 DocInsère DocInsère	Insère un objet dans un document de type Traitement de texte ou remplace le contenu du fragment en cours. Les objets manipulables sont : un élément, un document, un paragraphe, un texte, une image, un fragment.
Versions 22 et supérieures DocInsèreTableau Nouveauté 22 DocInsèreTableau DocInsèreTableau	Insère un tableau dans un document de type Traitement de texte.
Versions 22 et supérieures DocRecherche Nouveauté 22 DocRecherche DocRecherche	Recherche une chaîne de caractères : dans l’ensemble d'un document de type Traitement de texte. dans un fragment.
Versions 22 et supérieures DocSélectionne Nouveauté 22 DocSélectionne DocSélectionne	Sélectionne un fragment dans un champ Traitement de texte.

fonctions WLangage utilisant une syntaxe préfixée :


Versions 24 et supérieures <Variable docFragment>.Ajoute Nouveauté 24 <Variable docFragment>.Ajoute <Variable docFragment>.Ajoute	Ajoute un élément, un texte ou une image à la fin d'une variable docFragment.
Versions 24 et supérieures <Variable docFragment>.InsèreTableau Nouveauté 24 <Variable docFragment>.InsèreTableau <Variable docFragment>.InsèreTableau	Remplace le fragment spécifié par un tableau.
Versions 24 et supérieures <Variable docFragment>.Insère Nouveauté 24 <Variable docFragment>.Insère <Variable docFragment>.Insère	Remplace le contenu du fragment en cours. Les objets manipulables sont : un élément, un document, un paragraphe, un texte, une image, un fragment.

Voir Aussi

Version minimum requise

Version 22

Documentation également disponible pour…

Commentaires

Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 07/11/2019

Signaler une erreur ou faire une suggestion | Aide en ligne locale