Les constantes de la DLL DocxToolBx

Les différentes constantes liées aux paramètres des fonctions de la DLL DocxToolBx sont présentées ci-dessous :

Codes d'erreur

Les codes d'erreur susceptibles d'être retournés par les fonctions de la DocxToolBx sont les suivants :

Nom	Valeur	Description
_DOCX_ERR_NO_ERROR	0	Aucune erreur.
_DOCX_ERR_UNEXPECTED_ERROR	-1	Erreur inattendue.
_DOCX_ERR_OBJECT_NOT_FOUND	-2	Objet non trouvé.
_DOCX_ERR_OBJECT_ALREADY_EXIST	-3	L'objet existe déjà.
_DOCX_ERR_INVALID_PARAMETER	-4	Paramètre invalide.
_DOCX_ERR_INVALID_PARAMETER_TYPE	-5	Type du paramètre invalide.
_DOCX_ERR_INVALID_PARAMETER_COUNT	-6	Nombre de paramètres invalide.
_DOCX_ERR_IO_EXCEPTION	-7	Exception d'entrée/sortie.
_DOCX_ERR_DOCUMENT_EXCEPTION	-8	Exception de gestion du document.
_DOCX_ERR_INVALID_HANDLE	-9	Handle invalide.
_DOCX_ERR_INVALID_FILENAME	-10	Nom de fichier invalide.
_DOCX_ERR_INVALID_OBJECTTYPE	-11	Type d'objet invalide.
_DOCX_ERR_XML_EXCEPTION	-12	Exception XML.
_DOCX_ERR_NO_MORE_HANDLE	-13	Aucun handle n'est disponible.
_DOCX_ERR_UNKNOWN_METHOD	-14	Méthode inconnue.
_DOCX_ERR_INVALID_STYLE	-15	Style invalide.
_DOCX_ERR_BOOKMARK_NOT_REPLACABLE	-16	Signet non remplaçable.
_DOCX_ERR_OUT_OF_BOUNDS	-17	Index hors limite ou fin de recherche.
_DOCX_ERR_NOT_IMPLEMENTED	-18	Fonction non implémentée.

Unités de mesure

La DocxToolBx utilise deux unités de mesure distinctes. Certaines mesures (tailles de police, de bordures, etc.) sont exprimées en points, les autres mesures sont exprimées dans l'unité de base, qui est configurable (par défaut, le centimètre).

Nom	Valeur	Description
_DOCX_BASE_UNIT_CENTIMETERS	1	Centimètres.
_DOCX_BASE_UNIT_INCHES	2	Pouces.
_DOCX_BASE_UNIT_TWIPS	3	Twips (1 centimètre correspond à 567 twips, 1 pouce à 1440 twips).

Constantes de positionnement

Il s'agit des constantes utilisées pour définir le positionnement lors de l'insertion de nouveaux éléments dans le document.

De façon générale vous pouvez insérer un élément (paragraphe, tableau...) dans son parent (document, cellule de tableau...), soit de façon absolue, soit relativement à un autre élément contenu dans le parent.

Ces constantes s'appliquent à toutes les fonctions nécessitant une position d'insertion.

Nom	Valeur	Description
_DOCX_POS_FIRST	1	Insertion en début d'élément.
_DOCX_POS_LAST	2	Insertion en fin d'élément.
_DOCX_POS_BEFORE	3	Insertion avant le sous-élément frère donné.
_DOCX_POS_AFTER	4	Insertion après le sous-élément frère donné.
_DOCX_POS_ABSOLUTE	5	Insertion à la position fixée. Attention : dans ce cas, la position est indiquée à partir de zéro et non de un. Le premier élément a pour index "0".
_DOCX_POS_REPLACE	6	Insertion en remplacement du contenu complet de l'élément parent.

Types de styles

Les différents types de styles définis dans un document sont les suivants :

Nom	Valeur	Description
_DOCX_TYPE_STYLE_PARAGRAPH	paragraph	Style de paragraphe.
_DOCX_TYPE_STYLE_CHARACTER	character	Style de texte.
_DOCX_TYPE_STYLE_TABLE	table	Style de table.
_DOCX_TYPE_STYLE_NUMBERING	numbering	Style de liste à puces.

Alignement horizontal d'un paragraphe

Nom	Valeur	Description
_DOCX_HALIGN_LEFT	1	Alignement à gauche.
_DOCX_HALIGN_CENTER	2	Alignement au centre.
_DOCX_HALIGN_RIGHT	3	Alignement à droite.
_DOCX_HALIGN_JUSTIFY	4	Alignement justifié.
_DOCX_HALIGN_MEDIUM_KASHIDA	5	Alignement sur la longueur Kashida moyenne.
_DOCX_HALIGN_DISTRIBUTE	6	Alignement justifié (distribution des caractères).
_DOCX_HALIGN_NUM_TAB	7	Alignement sur la tabulation de la liste.
_DOCX_HALIGN_HIGH_KASHIDA	8	Alignement sur la longueur Kashida haute.
_DOCX_HALIGN_LOW_KASHIDA	9	Alignement sur la longueur Kashida basse.
_DOCX_HALIGN_THAI_DISTRIBUTE	10	Alignement justifié selon le langage Thaï.

Alignement vertical d'un paragraphe

Nom	Valeur	Description
_DOCX_VALIGN_TOP	1	Alignement en haut.
_DOCX_VALIGN_CENTER	2	Alignement au centre.
_DOCX_VALIGN_BASELINE	3	Alignement sur la ligne de base - non applicable si l'objet est une cellule.
_DOCX_VALIGN_BOTTOM	4	Alignement en bas.
_DOCX_VALIGN_AUTO	5	Alignement automatique - non applicable si l'objet est une cellule.

Propriétés de texte

Ces constantes regroupent les différentes propriétés permettant d'appliquer un style à un élément texte.

Nom	Valeur	Description
_DOCX_TEXT_PROP_ALIGN_BASELINE	1	Texte aligné sur la ligne de base.
_DOCX_TEXT_PROP_ALIGN_SUPERSCRIPT	2	Texte aligné en exposant.
_DOCX_TEXT_PROP_ALIGN_SUBSCRIPT	4	Texte aligné en indice.
_DOCX_TEXT_PROP_BOLD	8	Texte gras.
_DOCX_TEXT_PROP_ITALIC	16	Texte italique.
_DOCX_TEXT_PROP_STRIKE	32	Texte barré.
_DOCX_TEXT_PROP_DOUBLE_STRIKE	64	Texte doublement barré.
_DOCX_TEXT_PROP_OUTLINE	128	Texte encadré.
_DOCX_TEXT_PROP_SHADOW	256	Texte ombré.
_DOCX_TEXT_PROP_EMBOSS	1024	Texte bosselé.
_DOCX_TEXT_PROP_IMPRINT	2048	Texte en empreinte.
_DOCX_TEXT_PROP_VANISH	4096	Texte dissipé.
_DOCX_TEXT_PROP_RTL	8192	Texte lu de droite à gauche.

Types de soulignement

Nom	Valeur	Description
_DOCX_UNDERLINE_SINGLE	1	Soulignement simple.
_DOCX_UNDERLINE_WORDS	2	Soulignement des mots.
_DOCX_UNDERLINE_DOUBLE	3	Soulignement double.
_DOCX_UNDERLINE_THICK	4	Soulignement épais.
_DOCX_UNDERLINE_DOTTED	5	Soulignement point.
_DOCX_UNDERLINE_DOTTED_HEAVY	6	Soulignement point épais.
_DOCX_UNDERLINE_DASH	7	Soulignement tiret.
_DOCX_UNDERLINE_DASHED_HEAVY	8	Soulignement tiret gras.
_DOCX_UNDERLINE_DASH_LONG	9	Soulignement tiret long.
_DOCX_UNDERLINE_DASH_LONG_HEAVY	10	Soulignement tiret long gras.
_DOCX_UNDERLINE_DOT_DASH	11	Soulignement point-tiret.
_DOCX_UNDERLINE_DASH_DOT_HEAVY	12	Soulignement tiret-point gras.
_DOCX_UNDERLINE_DOT_DOT_DASH	13	Soulignement point-point-tiret.
_DOCX_UNDERLINE_DASH_DOT_DOT_HEAVY	14	Soulignement tiret-point-point gras.
_DOCX_UNDERLINE_WAVE	15	Soulignement vaguelette.
_DOCX_UNDERLINE_WAVY_HEAVY	16	Soulignement vaguelette épaisse.
_DOCX_UNDERLINE_WAVY_DOUBLE	17	Soulignement vaguelette double.
_DOCX_UNDERLINE_NONE	18	Pas de soulignement.

Types de marques de tabulation

Ces constantes représentent les différentes marques de tabulation accessibles.

Nom	Valeur	Description
_DOCX_TAB_LEFT	1	Tabulation gauche.
_DOCX_TAB_CENTER	2	Tabulation centrée.
_DOCX_TAB_RIGHT	3	Tabulation droite.

Règles de taillage vertical

Ces constantes s'appliquent à la définition de la hauteur d'une ligne.

Nom	Valeur	Description
_DOCX_HEIGHT_RULE_AUTO	1	Hauteur automatique.
_DOCX_HEIGHT_RULE_LEAST	2	Hauteur supérieure ou égale à.
_DOCX_HEIGHT_RULE_EXACT	3	Hauteur exactement de.

Règles d'espacement de lignes

Ces constantes s'appliquent à la définition de l'espacement vertical des lignes dans un paragraphe.

Nom	Valeur	Description
_DOCX_SPACING_RULE_AUTO	1	Interligne automatique.
_DOCX_SPACING_RULE_LEAST	2	Interligne supérieure ou égale à.
_DOCX_SPACING_RULE_EXACT	3	Interligne exactement de.

Sélection de bordures

Ces constantes permettent de définir quelle(s) bordure(s) sont traitées par les fonctions de style gérant les bordures d'élément.

Lorsque vous récupérez les informations, vous devez spécifier explicitement la bordure à traiter (par exemple : BORDER_BOTTOM).

Si vous définissez un style de bordure, vous pouvez l'appliquer à plusieurs bordures simultanément en combinant les valeurs (exemple BORDER_TOP + BORDER_LEFT + BORDER_BOTTOM + BORDER_RIGHT pour appliquer au cadre complet).

Nom	Valeur	Description
_DOCX_BORDER_TOP	1	Bordure haute.
_DOCX_BORDER_LEFT	2	Bordure gauche.
_DOCX_BORDER_BOTTOM	4	Bordure basse.
_DOCX_BORDER_RIGHT	8	Bordure droite.
_DOCX_BORDER_INSIDE_H	16	Bordure intérieure horizontale.
_DOCX_BORDER_INSIDE_V	32	Bordure intérieur verticale.
_DOCX_BORDER_BETWEEN	16	Bordure intermédiaire.
_DOCX_BORDER_BAR	32	Bordure barre.

Types de bordures

Ces constantes permettent de définir le type des bordures d'élément.

Nom	Valeur	Description
_DOCX_BST_SINGLE	single	Ligne seule.
_DOCX_BST_DASH_DOT_STROKED	dashDotStroked	Ligne avec une série de tirets en alternance minces et épais.
_DOCX_BST_DASHED	dashed	Ligne pointillée.
_DOCX_BST_DASH_SMALL_GAP	dashSmallGap	Ligne pointillée avec de petits écarts.
_DOCX_BST_DOT_DASH	dotDash	Ligne avec des points et des tirets alternés.
_DOCX_BST_DOT_DOT_DASH	dotDotDash	Tirets.
_DOCX_BST_DOTTED	dotted	Ligne pointillée.
_DOCX_BST_DOUBLE	double	Ligne double.
_DOCX_BST_DOUBLE_WAVE	doubleWave	Ligne double ondulée.
_DOCX_BST_INSET	inset	Ensemble de lignes d'encart.
_DOCX_BST_NIL	nil	Pas de bordure.
_DOCX_BST_NONE	none	Pas de bordure.
_DOCX_BST_OUTSET	outset	Ensemble de lignes de départ.
_DOCX_BST_THICK	thick	Ligne épaisse.
_DOCX_BST_THICK_THIN_LARGE_GAP	thickThinLargeGap	Ligne épaisse contenue dans une ligne mince avec un espace intermédiaire de grande taille.
_DOCX_BST_THICK_THIN_MEDIUM_GAP	thickThinMediumGap	Ligne épaisse contenue dans une fine ligne avec un espace intermédiaire de taille moyenne.
_DOCX_BST_THICK_THIN_SMALL_GAP	thickThinSmallGap	Ligne épaisse contenue dans une ligne mince avec un petit espace intermédiaire.
_DOCX_BST_THIN_THICK_LARGE_GAP	thinThickLargeGap	Fine ligne contenue dans une ligne épaisse avec un espace intermédiaire de grande taille.
_DOCX_BST_THIN_THICK_MEDIUM_GAP	thinThickMediumGap	Ligne épaisse contenue dans une fine ligne avec un espace intermédiaire de taille moyenne.
_DOCX_BST_THIN_THICK_SMALL_GAP	thinThickSmallGap	Ligne épaisse contenue dans une ligne mince avec un petit espace intermédiaire.
_DOCX_BST_THIN_THICK_THIN_LARGE_GAP	thinThickThinLargeGap	Tirets mince épais mince avec un grand écart.
_DOCX_BST_THIN_THICK_THIN_MEDIUM_GAP	thinThickThinMediumGap	Tirets mince épais mince avec un écart moyen.
_DOCX_BST_THIN_THICK_THIN_SMALL_GAP	thinThickThinSmallGap	Tirets mince épais mince avec un petit écart.
_DOCX_BST_THREED_EMBOSS	threeDEmboss	Ligne de gradient en trois étapes, plus sombre vers le paragraphe.
_DOCX_BST_THREED_ENGRAVE	threeDEngrave	Gradient en trois étapes.
_DOCX_BST_TRIPLE	triple	Ligne triple.
_DOCX_BST_WAVE	wave	Ligne ondulée.

Types d'objets manipulables

Ces constantes représentent les types d'objets directement manipulables utilisés par la DocxToolBx.

Nom	Valeur	Description
_DOCX_OBJECT_TYPE_PARAGRAPH	1	Paragraphe de texte.
_DOCX_OBJECT_TYPE_RUN	2	Sous-élément texte d'un paragraphe.
_DOCX_OBJECT_TYPE_TABLE	3	Tableau.
_DOCX_OBJECT_TYPE_TABLE_ROW	4	Ligne d'un tableau.
_DOCX_OBJECT_TYPE_TABLE_CELL	5	Cellule d'un tableau.

Types de sauts

Ces constantes représentent les types les types de saut (de page, de section, etc.) utilisables.

Nom	Valeur	Description
_DOCX_BREAK_TYPE_PAGE	1	Saut de page.
_DOCX_BREAK_TYPE_COLUMN	2	Saut de colonne.

Types d'en-têtes ou de pieds de page

Ces constantes représentent les types d'en-têtes et de pieds de page.

Nom	Valeur	Description
_DOCX_HEADER_TYPE_DEFAULT	1	Standard.
_DOCX_HEADER_TYPE_EVEN	2	Pages impaires.
_DOCX_HEADER_TYPE_FIRST	3	Première page.

Mode de création d'un en-tête ou d'un pied de page

Ces constantes représentent les modes de création pour les fonctions GetHeader et GetFooter.

Nom	Valeur	Description
_DOCX_CRH_FAILS_IF_NOT_EXISTS	0	Renvoie une erreur si le header demandé n'existe pas.
_DOCX_CRH_FALLBACK_TO_DEFAULT	1	Renvoie le header par défaut (et le créé si nécessaire) si le header demandé n'existe pas.
_DOCX_CRH_CREATE_IF_NOT_EXISTS	2	Crée le header s'il n'existe pas.
_DOCX_CRH_CREATE_ALWAYS	3	Crée le header s'il n'existe pas.

Paramètres du document

Il s'agit des paramètres du document lisibles ou modifiables à l'aide des fonctions DocGetParameter, DocSetParameter et DocRemoveParameter.

Ces fonctions ne gèrent que les types simples de paramètres (chaînes de caractères, numériques, booléens ou types énumérés).

Veuillez vous référencer à la documentation OpenXML pour la signification des différents paramètres. Modifiez ces paramètres avec précaution, aucun contrôle de validité n'est fait lors de la modification.

Nom	Valeur	Description
AlignBordersAndEdges	booléen	true, false.
AlwaysMergeEmptyNamespace	booléen	true, false.
AlwaysShowPlaceholderText	booléen	true, false.
AutoFormatOverride	booléen	true, false.
AutoHyphenation	booléen	true, false.
BookFoldPrinting	booléen	true, false.
BookFoldPrintingSheets	entier
BookFoldRevPrinting	booléen	true, false.
BordersDoNotSurroundFooter	booléen	true, false.
BordersDoNotSurroundHeader	booléen	true, false.
CharacterSpacingControl	chaîne de caractères	doNotCompress, compressPunctuation, ou compressPunctuationAndJapaneseKana.
ChartTrackingRefBased	booléen	true, false.
ClickAndTypeStyle	chaîne de caractères
ConflictMode	chaîne de caractères	true, false, on, off, 0, 1.
ConsecutiveHyphenLimit	entier
DecimalSymbol	chaîne de caractères
DefaultImageDpi	entier
DefaultTableStyle	chaîne de caractères
DefaultTabStop	numérique	Mesure convertie dans l'unité sélectionnée (centimètre par défaut).
DiscardImageEditingData	chaîne de caractères	true, false, on, off, 0, 1.
DisplayBackgroundShape	booléen	true, false.
DisplayHorizontalDrawingGridEvery	entier
DisplayVerticalDrawingGridEvery	entier
DocId14	chaîne de caractères
DocId15	chaîne de caractères
DocumentType	chaîne de caractères	notSpecified, letter, ou eMail.
DoNotAutoCompressPictures	booléen	true, false.
DoNotDemarcateInvalidXml	booléen	true, false.
DoNotDisplayPageBoundaries	booléen	true, false.
DoNotEmbedSmartTags	booléen	true, false.
DoNotHyphenateCaps	booléen	true, false.
DoNotIncludeSubdocsInStats	booléen	true, false.
DoNotShadeFormData	booléen	true, false.
DoNotTrackFormatting	booléen	true, false.
DoNotTrackMoves	booléen	true, false.
DoNotUseMarginsForDrawingGridOrigin	booléen	true, false.
DoNotValidateAgainstSchema	booléen	true, false.
DrawingGridHorizontalOrigin	numérique	Mesure convertie dans l'unité sélectionnée (centimètre par défaut).
DrawingGridHorizontalSpacing	numérique	Mesure convertie dans l'unité sélectionnée (centimètre par défaut).
DrawingGridVerticalOrigin	numérique	Mesure convertie dans l'unité sélectionnée (centimètre par défaut).
DrawingGridVerticalSpacing	numérique	Mesure convertie dans l'unité sélectionnée (centimètre par défaut).
EmbedSystemFonts	booléen	true, false.
EmbedTrueTypeFonts	booléen	true, false.
EvenAndOddHeaders	booléen	true, false.
FormsDesign	booléen	true, false.
GutterAtTop	booléen	true, false.
HideGrammaticalErrors	booléen	true, false.
HideSpellingErrors	booléen	true, false.
HyphenationZone	numérique	Mesure convertie dans l'unité sélectionnée (centimètre par défaut).
Ignorable	chaîne de caractères
IgnoreMixedContent	booléen	true, false.
LinkStyles	booléen	true, false.
ListSeparator	chaîne de caractères
MirrorMargins	booléen	true, false.
NoLineBreaksAfter	chaîne de caractères
NoLineBreaksBefore	chaîne de caractères
NoPunctuationKerning	booléen	true, false.
PrintFormsData	booléen	true, false.
PrintFractionalCharacterWidth	booléen	true, false.
PrintPostScriptOverText	booléen	true, false.
PrintTwoOnOne	booléen	true, false.
RemoveDateAndTime	booléen	true, false.
RemovePersonalInformation	booléen	true, false.
SaveFormsData	booléen	true, false.
SaveInvalidXml	booléen	true, false.
SavePreviewPicture	booléen	true, false.
SaveSubsetFonts	booléen	true, false.
SaveXmlDataOnly	booléen	true, false.
ShowEnvelope	booléen	true, false.
ShowXMLTags	booléen	true, false.
StrictFirstAndLastChars	booléen	true, false.
StyleLockQFSet	booléen	true, false.
StyleLockTheme	booléen	true, false.
StylePaneFormatFilter	chaîne de caractères
StylePaneSortMethod	chaîne de caractères
SummaryLength	entier
ThemeFontLang	chaîne de caractères
TrackRevisions	booléen	true, false.
UiCompat97To2003	booléen	true, false.
UpdateFields	booléen	true, false.
UseXSLTWhenSaving	booléen	true, false.
View	chaîne de caractères	none, print, outline, masterPages, normal, ou web.
Zoom	chaîne de caractères	none, fullPage, bestFit, ou textFit.

Cliquez ci-dessous pour plus d'informations sur :

↑ Haut de page