DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Fonctions WLangage / Champs, pages et fenêtres / Fonctions Traitement de texte / Types de variable
  • Propriétés spécifiques à la description des variables de type docFragment
  • Fonctions WLangage utilisant les variables de type docFragment
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
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.MiseEnForme.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
Document dans lequel l'extraction d'un fragment doit être effectuée. Ce document correspond :
  • WINDEV 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émentTableau de docElémentEléments composant le fragment du document manipulé. Il est possible de parcourir les éléments du fragment via l'instruction POUR TOUT.
EtendueEntierNombre 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.
IdentifiantSousDocumentEntierIdentifiant correspondant au sous-document associé au fragment. Cette propriété est d'un usage avancé.
LangueOrthographeChaîne de caractèresLangue 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.
MiseEnFormeVariable de type docMiseEnFormeInformations de mise en forme de tous les éléments composant le fragment du document manipulé.
MiseEnPage
Mise en page du fragment en cours.
MiseEnPage.CouleurFondEntierCouleur de fond du fragment. Cette couleur peut correspondre à :
MiseEnPage.TrameFondVariable de type FondCaractéristiques de fond du fragment.
MotTableau de docFragmentMots composant le fragment du document manipulé. Il est possible de parcourir les mots du fragment via l'instruction POUR TOUT.
ParagrapheTableau de docParagrapheParagraphes 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ébutEntierPosition du début du fragment. Cette position est relative au document entier.
PositionFinEntierPosition de fin du fragment. Cette position est relative au document entier.
StyleIDChaîne de caractèresIdentifiant 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.
TexteChaîne de caractèresTexte brut correspondant au contenu du fragment manipulé.
TypeSousDocumentConstante de type EntierPartie du document auquel le fragment appartient. Les valeurs possibles sont les suivantes :
  • 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.
  • typeSousDocZoneDeTexte : Zone de texte.
Cette propriété est disponible en lecture seulement.

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 :
    DocAjouteAjoute :
    • à 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.
    DocInsèreInsè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.
    DocInsèreTableauInsère un tableau dans un document de type Traitement de texte.
    DocRechercheRecherche une chaîne de caractères :
    • dans l'ensemble d'un document de type Traitement de texte.
    • dans un fragment.
    DocSélectionneSélectionne un fragment dans un champ Traitement de texte.
  • fonctions WLangage utilisant une syntaxe préfixée :
    <Variable docFragment>.AjouteAjoute un élément, un texte ou une image à la fin d'une variable docFragment.
    <Variable docFragment>.InsèreRemplace le contenu du fragment en cours. Les objets manipulables sont :
    • un élément,
    • un document,
    • un paragraphe,
    • un texte,
    • une image,
    • un fragment.
    <Variable docFragment>.InsèreTableauRemplace le fragment spécifié par un tableau.
Version minimum requise
  • Version 22
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 22/07/2022

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