Les méthodes de l'objet CLIENT WORD - Préfixe DOC

DOC_ACTIVER

Active le document NomDocument dans l'application Microsoft Word.

Le paramètre CodeRetour permet de savoir si l'exécution de la méthode a réussi.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_ACTIVER NomDocument CodeRetour
Paramètres
NomDocument	Type ALPHA(50) (paramètre en entrée)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

Remarque : lorsqu'un autre document est activé, la plage courante n'est plus valide. Il faut donc fixer une nouvelle plage si nécessaire.

DOC_ALLER_A

Positionne et réduit la plage courante au début de l'élément spécifié en fonction des indications suivantes :

Type	Type de l'élément vers lequel doit être déplacée la plage,
TypeDeplacement	Type du déplacement à effectuer,
Numero	Numéro de l'élément dans le document, de valeur positive,
Nom	Nom de l'élément si ce dernier est un signet, un commentaire ou un champ.

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe

APPELER_METHODE NomObjetClientWord DOC_ALLER_A Type TypeDeplacement Numero Nom CodeRetour

Paramètres

Type

Type NUM_BIN_4 (paramètre en entrée)

Valeurs possibles :

_WRD_VERS_SIGNET	la plage est déplacée vers un signet,
_WRD_VERS_COMMENTAIRE	la plage est déplacée vers un commentaire,
_WRD_VERS_NOTE_FIN	la plage est déplacée vers une note de fin,
_WRD_VERS_EQUATION	la plage est déplacée vers une équation,
_WRD_VERS_CHAMP	la plage est déplacée vers un champ,
_WRD_VERS_NOTE_PIED_PAGE	la plage est déplacée vers une note de pied de page,
_WRD_VERS_ERREUR_GRAMMAIRE	la plage est déplacée vers une erreur de grammaire,
_WRD_VERS_GRAPHIQUE	la plage est déplacée vers un graphique,
_WRD_VERS_TITRE	la plage est déplacée vers un titre,
_WRD_VERS_LIGNE	la plage est déplacée vers une ligne,
_WRD_VERS_OBJET	la plage est déplacée vers un objet,
_WRD_VERS_PAGE	la plage est déplacée vers une page,
_WRD_VERS_SECTION	la plage est déplacée vers une section,
_WRD_VERS_TABLEAU	la plage est déplacée vers un tableau.

TypeDeplacement

Type NUM_BIN_4 (paramètre en entrée)

Valeurs possibles :

_WRD_DEPLACEMENT_ABSOLU	le déplacement est absolu,
_WRD_DEPLACEMENT_VERS_PREMIER	la plage est déplacée vers le premier élément,
_WRD_DEPLACEMENT_VERS_DERNIER	la plage est déplacée vers le dernier élément,
_WRD_DEPLACEMENT_VERS_SUIVANT	la plage est déplacée vers l'élément suivant,
_WRD_DEPLACEMENT_VERS_PRECEDENT	la plage est déplacée vers l'élément précédent,
_WRD_DEPLACEMENT_RELATIF	le déplacement est relatif.

Numero

Type NUM_BIN_4 (paramètre en entrée)

Nom

Type ALPHA(50) (paramètre en entrée)

CodeRetour

Type NUM_BIN_4 (paramètre en sortie)

DOC_CHARGER

Crée dans l'application Microsoft Word le document dont le nom est contenu dans une variable Source d'une application Visual Adélia.

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_CHARGER Source CodeRetour
Paramètres
Source	Type IMAGE (paramètre en entrée)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_CREER

Crée un nouveau document dans l'application Microsoft Word en prenant comme modèle de document le modèle éventuellement fourni par CheminNomFichier .

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_CREER CheminNomFichier CodeRetour
Paramètres
CheminNomFichier	Type ALPHA(260) (paramètre en entrée)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_ENREGISTRER

Enregistre le document actif sur un support.

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_ENREGISTRER CodeRetour
Paramètres
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_ENREGISTRER_SOUS

Enregistre le document actif sur un support avec le chemin et le nom spécifiés dans CheminNomFichier .

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_ENREGISTRER_SOUS CheminNomFichier CodeRetour
Paramètres
CheminNomFichier	Type ALPHA(260) (paramètre en entrée)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_FERMER

Ferme le document actif de Microsoft Word et effectue ou non la sauvegarde en fonction de la valeur du paramètre SauverModifications .

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_FERMER SauverModifications CodeRetour
Paramètres
SauverModifications	Type BOOL (paramètre en entrée)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_FIXER_OPTION

Fixe une option au niveau du document courant.

Option	Option dont on veut fixer la valeur.
Valeur	Nouvelle valeur de l'option.

Syntaxe

APPELER_METHODE NomObjetClientWord DOC_FIXER_OPTION Option Valeur CodeRetour

Paramètres

Option

Type NUM_BIN_4 (paramètre en entrée).

Valeurs possibles :

_WRD_MONTRER_ERREURS_ORTHOGRAPHE	BOOL	Indique à Word de souligner les fautes d'orthographe dans le document. Pour les afficher à l'écran, il faut aussi utiliser la méthode APP_FIXER_OPTION pour les détecter.
_WRD_MONTRER_ERREURS_GRAMMAIRE	BOOL	Indique à Word de souligner les fautes de grammaire dans le document. Pour les afficher à l'écran, il faut aussi utiliser la méthode APP_FIXER_OPTION pour les détecter.

Valeur

Le type dépend de l'option (paramètre en entrée).

CodeRetour

Type NUM_BIN_4 (paramètre en sortie).

Valeurs possibles :

_WRD_ERR_OK	La méthode s'est bien déroulée.
_WRD_ERR_EXEC	L'exécution de la méthode a échoué.
_WRD_ERR_TYPE	Le paramètre Valeur ne possède pas le bon type Adélia.
_WRD_ERR_PARAM	Le paramètre Option ne possède pas une valeur correcte.

Exemple >>

DOC_IMPRIMER

Imprime les pages spécifiées du document actif sur l'imprimante par défaut de Microsoft Word en tenant compte des indications suivantes :

DeLaPage	numéro de la première page à imprimer,
ALaPage	numéro de la dernière page à imprimer,
NbCopies	nombre de copies à imprimer.

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe

APPELER_METHODE NomObjetClientWord DOC_IMPRIMER DeLaPage ALaPage NbCopies CodeRetour

Paramètres

DeLaPage

Type NUM_BIN_2 (paramètre en entrée)

ALaPage

Type NUM_BIN_2 (paramètre en entrée)

Valeurs possibles :

un entier	inférieur ou égal au nombre de pages du document,
_WRD_TOUTES_LES_PAGES	toutes les pages de numéro supérieur ou égal au numéro de la page de départ (DeLaPage) sont imprimées

NbCopies

Type NUM_BIN_2 (paramètre en entrée)

CodeRetour

Type NUM_BIN_4 (paramètre en sortie)

DOC_OBTENIR

Récupère un document dans une variable d'une application Visual Adélia, selon les indications suivantes :

NomDocument	nom du document à récupérer,
Cible	variable dans laquelle le document est récupéré,

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_OBTENIR NomDocument Cible CodeRetour
Paramètres
NomDocument	Type ALPHA(50) (paramètre en entrée)
Cible	Type IMAGE (paramètre en sortie)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_OUVRIR

Ouvre, dans l'application Microsoft Word, le document dont le chemin complet est indiqué dans CheminNomFichier .

Le paramètre CodeRetour prend la valeur 0 si la méthode s'est bien déroulée, et une valeur différente de 0 dans le cas contraire.

Syntaxe
APPELER_METHODE NomObjetClientWord DOC_OUVRIR CheminNomFichier CodeRetour
Paramètres
CheminNomFichier	Type ALPHA(260) (paramètre en entrée)
CodeRetour	Type NUM_BIN_4 (paramètre en sortie)

DOC_RECUPERER_OPTION

Récupère la valeur d'une option définie au niveau du document courant.

Option	Option dont on veut récupérer la valeur.
Valeur	Valeur de l'option.

Syntaxe

APPELER_METHODE NomObjetClientWord DOC_RECUPERER_OPTION Option Valeur CodeRetour

Paramètres

Option

Type NUM_BIN_4 (paramètre en entrée).

Valeurs possibles :

_WRD_MONTRER_ERREURS_ORTHOGRAPHE	BOOL	Informe si Word souligne les fautes d'orthographe dans le document.
_WRD_MONTRER_ERREURS_GRAMMAIRE	BOOL	Informe si Word souligne les fautes de grammaire dans le document.

Valeur

Le type dépend de l'option (paramètre en sortie).

CodeRetour

Type NUM_BIN_4 (paramètre en sortie).

Valeurs possibles :

_WRD_ERR_OK	La méthode s'est bien déroulée.
_WRD_ERR_EXEC	L'exécution de la méthode a échoué.
_WRD_ERR_TYPE	Le paramètre Valeur ne possède pas le bon type Adélia.
_WRD_ERR_PARAM	Le paramètre Option ne possède pas une valeur correcte.

Exemple >>

Voir aussi...

↑ Haut de page