MoveWhenInTheWay, propriété

Cette propriété a la valeur True si la fenêtre du Compagnon Office se déplace automatiquement lorsqu'elle gêne l'utilisateur dans sa zone de travail. Par exemple, le Compagnon se déplace, si lors d'un glisser-déplacer ou en réponse à des entrées clavier, vous faites glisser le curseur dessus. Type de données Boolean en lecture-écriture.

Remarque

La propriété MoveWhenInTheWay correspond à l'option Déplacer la fenêtre si elle me gêne située sous Options du compagnon, sous l'onglet Options de la boîte de dialogue Compagnon Office.


MoveWhenInTheWay, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office à un emplacement spécifique, puis définir plusieurs options avant de le rendre visible.

With Assistant

    .Reduced = True

    .Left = 400

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimGreeting

End With


NewBalloon, propriété

Crée une info-bulle pour le Compagnon Office. Renvoie un objet de type Balloon.


NewBalloon, propriété - Exemple

Cet exemple montre comment créer une info-bulle avec un en-tête, du texte et le choix entre trois régions, puis comment afficher l'info-bulle.

With Assistant.NewBalloon

    .Button = msoButtonSetOK

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With


Reduced, propriété

Cette propriété a la valeur True si la fenêtre du Compagnon Office apparaît dans sa taille minimale. Type de données Boolean en lecture-écriture.


Reduced, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office à un emplacement spécifique, et comment définir plusieurs options avant de le rendre visible.

With Assistant

    .Reduced = True

    .Left = 400

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimationGreeting

End With


SearchWhenProgramming, propriété

Cette propriété a la valeur True si le Compagnon Office affiche l'aide sur l'application et sur la programmation lorsque l'utilisateur travaille dans Visual Basic. Type de données Boolean en lecture-écriture.

Remarque

La propriété SearchWhenProgramming correspond à l'option Aide sur le produit et la programmation située sous Options du compagnon, sous l'onglet Options de la boîte de dialogue Compagnon Office.


SearchWhenProgramming, propriété - Exemple

Cet exemple vous permet de rechercher l'aide sur l'application et sur la programmation lorsque vous travaillez dans Visual Basic.

Assistant.SearchWhenProgramming = True


Show, méthode

Objet Balloon : affiche l'objet info-bulle spécifié. Renvoie une constante msoBalloonType qui indique l'info-bulle sur laquelle l'utilisateur doit cliquer.

Objet FileFind : affiche la boîte de dialogue Find File et les critères de recherche en cours. Disponible uniquement sur Macintosh.

Syntaxe

expression.Show

expression    Obligatoire. Expression qui renvoie un objet Balloon ou un objet FileFind.

Remarque

Pour l'objet Balloon, vous pouvez utiliser la valeur renvoyée par la méthode Show pour afficher le bouton sélectionné par l'utilisateur. La méthode Show renvoie l'une des constantes suivantes :

msoBalloonButtonAbort msoBalloonButtonCancel msoBalloonButtonIgnore msoBalloonButtonNo msoBalloonButtonOK msoBalloonButtonRetry msoBalloonButtonSnooze msoBalloonButtonYes	msoBalloonButtonBack msoBalloonButtonClose msoBalloonButtonNext msoBalloonButtonNull msoBalloonButtonOptions msoBalloonButtonSearch msoBalloonButtonTips msoBalloonButtonYesToAll


Show, méthode - Exemple

Cet exemple montre comment créer une info-bulle avec trois choix. La variable x contient la valeur renvoyée par la méthode Show, c'est-à-dire 1, 2 ou 3, qui correspond à l'étiquette sur laquelle clique l'utilisateur. Dans l'exemple, la valeur de la variable x est simplement affichée dans un message, mais vous pouvez la transmettre à une autre procédure ou l'utiliser dans une instruction Select Case.

Set b = Assistant.NewBalloon

With b

    .Heading = "This is my heading"

    .Text = "Select one of these things:"

    .Labels(1).Text = "Choice One"

    .Labels(2).Text = "Choice Two"

    .Labels(3).Text = "Choice Three"

    x = .Show

End With

MsgBox x


Sounds, propriété

Cette propriété a la valeur True si le Compagnon Office génère les sons correspondant aux animations. Type de données Boolean en lecture-écriture.

Remarque

Cette propriété est appliquée uniquement si une carte son est installée.


Sounds, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office, l'animer et générer des sons.

With Assistant

    .Visible = True

    .Sounds = True

    .Animation = msoAnimationBeginSpeaking

End With


TipOfDay, propriété

Cette propriété a la valeur True si le Compagnon Office affiche une astuce spéciale à chaque ouverture de l'application Office. Type de données Boolean en lecture-écriture.

Remarque

La propriété TipofDay correspond à l'option Astuce du jour au démarrage située sous Autres options pour les astuces, sous l'onglet Options de la boîte de dialogue Compagnon Office.


TipOfDay, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office à un emplacement spécifique, puis définir plusieurs options avant de le rendre visible.

With Assistant

    .Reduced = True

    .Left = 400

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimGreeting

End With


Animation, propriété

Renvoie ou définit l'action d'animation du Compagnon Office. Quand cette propriété est appliquée à l'objet Assistant, le Compagnon est animé immédiatement (s'il est visible). Quand elle est appliquée à l'objet Balloon, le Compagnon est animé uniquement pendant l'affichage de l'info-bulle. Type de données Long en lecture-écriture.

Il peut s'agir de l'une des constantes MsoAnimationType suivantes :

msoAnimationAppear msoAnimationBeginSpeaking msoAnimationCharacterSuccessMajor msoAnimationCheckingSomething msoAnimationDisappear msoAnimationEmptyTrash msoAnimationGestureDown msoAnimationGestureLeft msoAnimationGestureRight msoAnimationGestureUp msoAnimationGetArtsy msoAnimationGetAttentionMajor msoAnimationGetAttentionMinor msoAnimationGetTechy msoAnimationGetWizardy msoAnimationGoodbye msoAnimationGreeting	msoAnimationIdle msoAnimationListensToComputer msoAnimationLookDown msoAnimationLookDownLeft msoAnimationLookDownRight msoAnimationLookLeft msoAnimationLookRight msoAnimationLookUp msoAnimationLookUpLeft msoAnimationLookUpRight msoAnimationPrinting msoAnimationSaving msoAnimationSearching msoAnimationSendingMail msoAnimationThinking msoAnimationWorkingAtSomething msoAnimationWritingNotingSomething
Remarques

Trombine est le Compagnon par défaut et msoAnimationIdle est le type d'animation par défaut du Compagnon.

Selon le Compagnon sélectionné, définir la propriété Animation peut ou non aboutir à une animation évidente. Cependant, toutes les constantes MsoAnimationType sont valides pour tous les Compagnons.

Les constantes MsoAnimationType suivantes représentent des animations qui répètent l'action spécifiée jusqu'à ce que le Compagnon soit rendu invisible ou que la propriété Animation se voie affecter une autre constante.

msoAnimationCheckingSomething msoAnimationGetArtsy msoAnimationGetTechy msoAnimationSaving	msoAnimationSearching msoAnimationThinking msoAnimationWorkingAtSomething msoAnimationWritingNotingSomething


Animation, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office à un emplacement spécifique, puis définir plusieurs options avant de le rendre visible.

With Assistant

    .Reduced = True

    .Move xLeft:= 400, yTop:= 300

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimationGreeting

End With


FileName, propriété

Objet Assistant : renvoie ou définit le nom du fichier du Compagnon Office actif. Type de données String en lecture-écriture.

Objet FileSearch :renvoie ou définit le nom du fichier à rechercher au cours d'une recherche de fichier. Le nom du fichier peut comprendre les caractères génériques * (astérisque) ou ? (point d'interrogation).Utilisez le caractère générique point d'interrogation pour faire correspondre n'importe quel caractère unique. Par exemple, tapez gr?s pour faire correspondre à la fois « gris » et « gras ».Utilisez le caractère générique astérisque pour faire correspondre un nombre indéterminé de caractères. Par exemple, tapez *.txt pour rechercher tous les fichiers portant l'extension .txt. Type de données String en lecture-écriture.

Remarques

Sous Windows, l'extension de nom de fichier pour les fichiers Compagnon est .act et les fichiers sont installés dans le dossier \Program Files\Microsoft Office\Office\Actors sous Windows 95, dans le dossier  \Windows\MsApps\Actors sous Windows NT et dans le dossier Microsoft Assistants sur Macintosh.

Les noms de fichier suivants correspondent aux Compagnons d'Office 97.

Caractère	Nom de fichier
Logo Office	Logo.act
Médor	Powerpup.act
Professeur Génial	Genius.act
RobOffice	Hoverbot.act
Gribouille	Scribble.act
Bille de Clown	Dot.act
Trombine	Clippit.act
Mère Nature	MNature.act
William	Will.act


FileName, propriété - Exemple

Cet exemple montre comment utiliser la propriété FileName pour personnaliser le texte des info-bulles des Compagnons Office. Dans une info-bulle Assistant Impression, la variable btext peut être utilisée comme valeur de la propriété Text.

Select Case Lcase(Assistant.FileName)

Case "will.act"

    btext = "To Print, or Not to Print. That is the question."

Case "genius.act"

    btext = "The sum of the checkboxes equals the document to print."

Case Else

    btext = "Choose the document you want to print."

End Select

Cet exemple montre comment rechercher tous les fichiers situés dans le dossier My Documents dont le nom commence par cmd. Le nom et l'emplacement de chaque fichier trouvé s'affiche dans une boîte de message.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd*"

    If .Execute > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


BalloonType, propriété

Renvoie ou définit le type d'info-bulle utilisé par le Compagnon Office. Il peut s'agir de l'une des constantes MsoBalloonType suivantes : msoBalloonTypeButtons, msoBalloonTypeBullets ou msoBalloonTypeNumbers. Lorsque vous créez une info-bulle avec la méthode NewBalloon, cette propriété se voit initialement affecter la valeur msoBalloonTypeButtons. Type de données Long en lecture-écriture.


BalloonType, propriété - Exemple

Cet exemple montre comment créer une info-bulle fournissant les instructions à suivre pour sélectionner une imprimante. L'info-bulle est non modale, ce qui permet à l'utilisateur de suivre ses instructions et de la garder sous les yeux tout en travaillant.

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Printer."

    .Text = "Click OK when you've chosen a printer."

    .Labels(1).Text = "From the File menu, choose Print."

    .Labels(2).Text = "Click Setup."

    .Labels(3).Text = "Select the name of the printer."

    .BalloonType = msoBalloonTypeNumbers

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Button = msoButtonSetOK

    .Show

End With


Button, propriété

Renvoie ou définit le type de bouton affiché en bas de l'info-bulle du Compagnon Office. Lorsque vous créez une info-bulle avec la méthode NewBalloon, cette propriété se voit initialement affecter la valeur msoButtonSetOK. Type de données Long en lecture-écriture.

Il peut s'agir de l'une des constantes MsoButtonSetType suivantes :

msoButtonSetAbortRetryIgnore msoButtonSetBackClose msoButtonSetBackNextClose msoButtonSetBackNextSnooze msoButtonSetCancel msoButtonSetNextClose msoButtonSetNone msoButtonSetOK	msoButtonSetOkCancel msoButtonSetRetryCancel msoButtonSetSearchClose msoButtonSetTipsOptionsClose msoButtonSetYesAllNoCancel msoButtonSetYesNoCancel msoButtonSetYesNo


Button, propriété - Exemple

Cet exemple montre comment créer une info-bulle avec un en-tête, du texte et le choix entre trois régions. Un message affiche la sélection. Un message est affiché quand l'utilisateur active des cases à cocher, puis clique sur OK dans l'info-bullle.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

End With


Checkboxes, propriété

Renvoie une collection BalloonCheckboxes qui représente toutes les cases à cocher contenues dans l'info-bulle spécifié. En lecture seule.

Pour plus d'informations sur le renvoi d'un seul membre d'une collection, consultez Renvoi d'un objet à partir d'une collection.


Checkboxes, propriété - Exemple

Cet exemple montre comment créer une info-bulle avec un en-tête, du texte et le choix entre trois régions. Un mesage est affiché quand l'utilisateur active des cases à cocher, puis clique sur OK dans l'info-bulle.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

Select Case True

    Case .CheckBoxes(1).Checked

        runregion1

    Case .CheckBoxes(2).Checked

        runregion2

    Case .CheckBoxes(3).Checked

        runregion3

End Select

End With


Checked, propriété

Cette propriété a la valeur True si la case à cocher spécifiée dans l'info-bulle du Compagnon Office est activée. Type de données Boolean en lecture-écriture.


Checked, propriété - Exemple

Cet exemple montre comment créer une info-bulle avec un en-tête, du texte et le choix entre trois régions. Un message est affiché quand l'utilisateur active des cases à cocher, puis clique sur OK dans l'info-bulle.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = " Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

Select Case True

    Case .CheckBoxes(1).Checked

        runregion1

    Case .CheckBoxes(2).Checked

        runregion2

    Case .CheckBoxes(3).Checked

        runregion3

End Select

End With


FeatureTips, propriété

Cette propriété a la valeur True si le Compagnon Office fournit des informations d'aide relatives à l'utilisation plus efficace des fonctionnalités de l'application. Type de données Boolean en lecture-écriture.

Remarque

La propriété FeatureTips correspond à l'option Utilisation efficace du logiciel située sous l'onglet Options de la boîte de dialogue Compagnon Office.


FeatureTips, propriété - Exemple

Cet exemple montre comment demander au Compagnon Office de fournir des informations afin d'utiliser plus efficacement des fonctionnalités d'application.

Assistant.FeatureTips = True


GuessHelp, propriété

Cette propriété a la valeur True si le Compagnon Office affiche une liste des rubriques d'aide correspondant au contexte qui était en vigueur juste avant que l'utilisateur clique sur la fenêtre Compagnon ou appuie sur F1. Type de données Boolean en lecture-écriture.

Remarque

La propriété GuessHelp correspond à l'option Deviner la rubrique appropriée située sous Options du compagnon, sous l'onglet Options de la boîte de dialogue Compagnon Office.


GuessHelp, propriété - Exemple

Cet exemple montre comment définir le Compagnon Office pour qu'il devine les rubriques d'aide.

Assistant.GuessHelp = True


Heading, propriété

Renvoie ou définit l'en-tête qui apparaît dans l'info-bulle du Compagnon Office. Type de données String en lecture-écriture.

Remarque

Vous pouvez spécifier le graphisme à afficher en utilisant la syntaxe suivante : {type emplacement facteur_dimension}, la valeur de type étant bmp (image en mode point), wmf (métafichier Windows) ou pict (fichier PICT Macintosh), emplacement l'identificateur de la ressource ou le chemin d'accès et le nom de fichier, et facteur_dimension la largeur de l'image au format WMF ou PICT (non spécifié si l'image est au format BMP).


Heading, propriété - Exemple

Cet exemple montre comment créer une info-bulle avec un en-tête, du texte et le choix entre trois régions. Un message est affiché quand l'utilisateur active des cases à cocher, puis clique sur OK dans l'info-bulle.

With Assistant.NewBalloon

    .Button = msoButtonSetOkCancel

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With


Help, méthode

Affiche le Compagnon Office et l'info-bulle intégrée du Compagnon.

Syntaxe

expression.Help

expression   Obligatoire. Expression qui renvoie un objet Assistant.


Help, méthode - Exemple

Cet exemple montre comment afficher l'info-bulle intégrée du Compagnon quand l'utilisateur active la case à cocher " I need more information ".

Set b = Assistant.NewBalloon

With b

    .Heading = "User Information"

    .Text = "Select your skill level"

    .CheckBoxes(1).Text = "Beginner."

    .CheckBoxes(2).Text = "Advanced."

    .CheckBoxes(3).Text = "I need more information."

    .Show

End With

If b.CheckBoxes(3).Checked = True Then

    Assistant.Help

End If


AssistWithWizards, propriété

Cette propriété a la valeur True si le Compagnon Office fournit l'aide sur les assistants. Type de données Boolean en lecture-écriture.

Remarque

La propriété AssistWithWizards correspond à l'option Aide sur les assistants située sous Options du compagnon, sous l'onglet Options da la boîte de dialogue Compagnon Office.


AssistWithWizards, propriété - Exemple

Cet exemple montre comment définir le Compagnon Office pour qu'il fournisse l'aide sur les assistants.

Assistant.AssistWithWizards = True


HighPriorityTips, propriété

Cette propriété a la valeur True si le Compagnon Office affiche les astuces importantes. Type de données Boolean en lecture-écriture.

Remarque

La propriété HighPriorityTips correspond à l'option Uniquement astuces importantes située sous Autres options pour les astuces, sous l'onglet Options de la boîte de dialogue Compagnon Office.


HighPriorityTips, propriété - Exemple

Cet exemple montre comment définir le Compagnon Office pour qu'il affiche les astuces importantes.

Assistant.HighPriorityTips = True


Icon, propriété

Renvoie ou définit le type d'icône qui apparaît dans la partie supérieure gauche de l'info-bulle du Compagnon Office. Il peut s'agir de l'une des constantes MsoIconType suivantes : msoIconAlert, msoIconNone ou msoIconTip. Type de données String en lecture-écriture.


Icon, propriété - Exemple

Cet exemple montre comment créer une info-bulle avec une icône d'avertissement qui demande à l'utilisateur de sélectionner une imprimante.

With Assistant.NewBalloon

    .Heading = "Select A Printer"

    .Text = "You must select a printer before printing."

    .Icon = msoIconAlert

    .CheckBoxes(1).Text = "Local printer"

    .CheckBoxes(2).Text = "Network printer"

    .Show

End With


KeyboardShortcutTips, propriété

Cette propriété a la valeur True si le Compagnon Office fournit l'aide sur les raccourcis clavier. Type de données Boolean en lecture-écriture.

Remarque

La propriété KeyboardShortcutTips correspond à l'option Raccourcis clavier située sous Afficher les astuces sur, sous l'onglet Options de la boîte de dialogue Compagnon Office.


KeyboardShortcutTips, propriété - Exemple

Cet exemple montre comment définir le Compagnon Office pour qu'il fournisse l'aide sur les raccourcis clavier.

Assistant.KeyboardShortcutTips = True


Labels, propriété

Renvoie une collection BalloonLabels qui représente les étiquettes de bouton, de numéro et de puce contenues dans l'info-bulle du Compagnon Office spécifié. En lecture seule.

Pour plus d'informations sur le renvoi d'un seul membre d'une collection, consultez Renvoi d'un objet à partir d'une collection.


Labels, propriété - Exemple

Cet exemple montre comment créer une info-bulle contenant trois choix. La variable x se voit affecter la valeur renvoyée par la méthode Show, c'est-à-dire 1, 2 ou 3, qui correspond à l'étiquette sur laquelle clique l'utilisateur. Dans cet exemple, la valeur de la variable x est simplement affichée dans un message, mais vous pouvez la transmettre à une autre procédure ou l'utiliser dans une instruction Select Case.

Set b = Assistant.NewBalloon

With b

    .Heading = "This is my heading"

    .Text = "Select one of these things:"

    .Labels(1).Text = "Choice One"

    .Labels(2).Text = "Choice Two"

    .Labels(3).Text = "Choice Three"

    x = .Show

End With

MsgBox x


BalloonError, propriété

Renvoie une valeur qui indique la dernière erreur d'info-bulle enregistrée. Type de données String en lecture seule.

Il peut s'agir de l'une des constantes MsoBalloonErrorType suivantes :

Constante	Description
msoBalloonErrorBad PictureRef	L'info-bulle contient une image en mode point impossible à afficher, soit parce que le fichier n'existe pas, soit parce que l'image n'est pas un fichier .BMP ou .WMF (ou un fichier PICT sur Macintosh) valide.
msoBalloonErrorBadReference	L'info-bulle contient une référence non reconnue ou non prise en charge.
msoBalloonErrorButtonlessModal	L'info-bulle que vous essayez d'afficher est modale mais ne contient pas de bouton. L'info-bulle ne sera pas affichée parce qu'il serait impossible de la faire disparaître.
msoBalloonErrorButtonModeless	L'info-bulle que vous essayez d'afficher est non modale, ne contient pas de bouton et aucune procédure n'est affectée à sa propriété Callback. L'info-bulle ne sera pas affichée parce qu'une procédure est nécessaire pour déterminer quel bouton a été utilisé dans l'info-bulle.
msoBalloonErrorNone	La propriété a affiché l'info-bulle sans erreur.
msoBalloonErrorBadCharacter	L'info-bulle contient un code de contrôle ASCII autre que CR ou LF, et supérieur à 32.
msoBalloonErrorOutOfMemory	L'info-bulle n'apparaîtra pas, en raison d'une insuffisance de mémoire.
msoBalloonErrorTooBig	L'info-bulle est trop grosse pour apparaître à l'écran.
msoBalloonErrorOther	L'info-bulle ne s'affiche pas parce qu'une autre erreur s'est produite : par exemple, si une autre info-bulle modale est déjà active.


BalloonError, propriété - Exemple (Microsoft Office)
BalloonError, propriété - Exemple

Cet exemple montre comment créer une info-bulle qui génère une erreur. L'erreur est provoquée par la création d'une info-bulle impossible à faire disparaître : le bouton se voit affecter le type msoButtonSetNone et le mode de l'info-bulle par défaut est msoModeModal, ce qui donne une info-bulle sans bouton. Notez qu'il est impossible de faire disparaître une info-bulle modale sans bouton.

With Application.Assistant

With .NewBalloon

    .Heading = "This will never show."

    .Text = "Imagine a balloon here."

    .Button = msoButtonSetNone

    .Show

End With

.Visible = True

If .BalloonError = msoBalloonErrorButtonlessModal Then

    MsgBox "You need a button to dismiss the balloon."

End If

End With


Mode, propriété

Renvoie ou définit le type d'info-bulle affiché. Il peut s'agir de l'une des constantes MsoModeType suivantes : msoModeAutoDown, msoModeModal ou msoModeModeless. Lorsque vous créez une info-bulle avec la méthode NewBalloon, cette propriété se voit initialement affecter la valeur msoModeModal. Type de données Long en lecture-écriture.

Remarques

Si la propriété Mode d'une info-bulle se voit affecter la constante msoModeModeless, l'utilisateur peut travailler dans l'application tout en gardant l'info-bulle visible. Si la propriété se voit affecter la constante msoModeModal, l'utilisateur doit faire disparaître l'info-bulle avant de revenir dans l'application. Si la propriété se voit affecter la constante msoModeAutoDown, l'info-bulle disparaît instantanément quand l'utilisateur clique n'importe où sur l'écran.

Si la propriété Mode d'une info-bulle se voit affecter la constante msoModeModeless, il est obligatoire d'affecter une valeur à la propriété Callback. La méthode Close peut être utilisée uniquement si la propriété se voit affecter la valeur msoModeModeless.


Mode, propriété - Exemple

Cet exemple montre comment créer une info-bulle contenant une icône d'avertissement qui demande à l'utilisateur de sélectionner une imprimante. Comme l'info-bulle est non modale, l'utilisateur peut accéder aux commandes de l'imprimante en la gardant sous les yeux.

With Assistant.NewBalloon

    .Heading = "Select A Printer"

    .Text = "You must select a printer before printing."

    .Icon = msoIconAlert

    .CheckBoxes(1).Text = "Local printer"

    .CheckBoxes(2).Text = "Network printer"

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Show

End With


MouseTips, propriété

Cette propriété a la valeur True si le Compagnon Office affiche des astuces sur une utilisation plus efficace de la souris. Type de données Boolean en lecture-écriture.

Remarque

La propriété MouseTips correspond à l'option Utilisation efficace de la souris située sous Afficher les astuces sur, sous l'onglet Options de la boîte de dialogue Compagnon Office.


MouseTips, propriété - Exemple

Cet exemple montre comment définir le Compagnon Office pour qu'il affiche des astuces sur une utilisation plus efficace de la souris.

Assistant.MouseTips = True


Assistant, objet

Représente le Compagnon Microsoft Office.

Utilisation de l'objet Assistant

Pour renvoyer l'objet Assistant, utilisez la propriété Assistant. L'objet Assistant n'appartient pas à une collection et il ne peut y avoir qu'un seul objet Assistant actif à la fois. Pour afficher le Compagnon, utilisez la propriété Visible.

Remarque

Le compagnon par défaut est Trombine. Pour en sélectionner un autre par programme, utilisez la propriété FileName.

L'exemple suivant montre comment afficher un Compagnon précédemment sélectionné et l'animer avec le son associé. Si votre ordinateur ne dispose pas de carte son, cet exemple ne génère pas d'erreur, mais ne produit aucun son.

With Assistant

    .Visible = True

    .Sounds = True

    .Animation = msoAnimationBeginSpeaking

End With


Balloon, objet

Représente l'info-bulle dans laquelle le Compagnon Office affiche les en-têtes et les informations de type texte. Une info-bulle peut contenir des contrôles tels que des cases à cocher et des étiquettes.

Utilisation de l'objet Balloon

Pour renvoyer un objet Balloon, utilisez la propriété NewBalloon. L'objet Balloon n'appartient pas à une collection et il n'est possible d'afficher qu'une seule info-bulle à la fois. Cependant, il est possible de définir plusieurs info-bulles et d'appeler l'une d'entre elles en cas de besoin. Pour plus d'informations, consultez « Définition et réutilisation des info-bulles » plus loin dans cette rubrique.

Pour rendre visible l'info-bulle spécifiée, utilisez la méthode Show. Pour exécuter des procédures basées sur les sélections effectuées dans les info-bulles non modales (info-bulles qui restent visibles pendant que l'utilisateur travaille dans l'application), utilisez la propriété Callback. Pour fermer les info-bulles non modales, utilisez la méthode Close.

L'exemple suivant montre comment créer une info-bulle contenant des astuces sur l'enregistrement des données saisies.

With Assistant.NewBalloon

    .BalloonType = msoBalloonTypeBullets

    .Icon = msoIconTip

    .Button = msoButtonSetOkCancel

    .Heading = "Tips for Saving Information."

    .Labels(1).Text = "Save your work often."

    .Labels(2).Text = "Install a surge protector."

    .Labels(3).Text = "Exit your application properly."

    .Show

End With

Définition et réutilisation des info-bulles

Pour avoir la possibilité de réutiliser des info-bulles, affectez-les à des variables objet et appelez-les quand vous en avez besoin au cours de la procédure. Cet exemple montre comment définir les trois info-bulles balloon1, balloon2 et balloon3 et les afficher à différents points de la procédure.

Set balloon1 = Assistant.NewBalloon

balloon1.Heading = "First balloon"

Set balloon2 = Assistant.NewBalloon

balloon2.Heading = "Second balloon"

Set balloon3 = Assistant.NewBalloon

balloon3.Heading = "Third balloon

balloon1.Show

balloon3.Show

balloon2.Show

Vous pouvez aussi associer les variables objet info-bulle dans un tableau et indexer le tableau.


BalloonCheckboxes, collection d'objets

Collection d'objets BalloonCheckbox qui représente toutes les cases à cocher situées dans l'info-bulle du Compagnon Office.

Utilisation de la collection BalloonCheckboxes

Pour renvoyer la collection BalloonCheckboxes, utilisez la propriété Checkboxes.

Pour renvoyer un seul objet BalloonCheckbox, utilisez Checkboxes(index), index étant un nombre compris entre 1 et 5. Une info-bulle peut contenir un maximum de cinq cases à cocher ; une case apparaît quand une valeur est affectée à sa propriété Text.

L'exemple suivant montre comment écrire dans la fenêtre de débogage le texte de toutes les cases à cocher visibles dans une info-bulle existante.

For Each box In .CheckBoxes

    If box.Text <> "" Then

        Debug.Print box.Text

    End If

Next

Vous ne pouvez ni ajouter, ni supprimer de cases à cocher dans la collection BalloonCheckboxes.

Remarque

Les cases à cocher d'une info-bulle affichent les choix de l'utilisateur tant que ce dernier ne fait pas disparaître l'info-bulle. Les étiquettes de l'info-bulle enregistrent le choix de l'utilisateur dès que ce dernier clique sur un bouton situé à côté d'une étiquette.


BalloonCheckbox, objet

Représente une case à cocher dans l'info-bulle du Compagnon Office. L'objet BalloonCheckbox est un membre de la collection BalloonCheckboxes.

Utilisation de l'objet BalloonCheckbox

Pour renvoyer un seul objet BalloonCheckbox, utilisez Checkboxes(index), index étant un nombre compris entre 1 et 5. Une info-bulle peut contenir un maximum de cinq cases à cocher ; une case apparaît quand une valeur est affectée à sa propriété Text.

L'exemple suivant montre comment créer une info-bulle avec un en-tête, du texte et le choix entre trois régions. Un message est affiché quand l'utilisateur active des cases à cocher, puis clique sur OK dans l'info-bulle.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

    Select Case True

        Case .CheckBoxes(1).Checked

            runregion1

        Case .CheckBoxes(2).Checked

            runregion2

        Case .CheckBoxes(3).Checked

            runregion3

    End Select

End With

Remarque

Les cases à cocher d'une info-bulle affichent les choix de l'utilisateur tant que ce dernier ne fait pas disparaître l'info-bulle. Les étiquettes de l'info-bulle enregistrent le choix de l'utilisateur dès que ce dernier clique sur un bouton situé à côté d'une étiquette.


BalloonLabels, collection d'objets

Collection d'objets BalloonLabel qui représente toutes les étiquettes de l'info-bulle du Compagnon Office.

Utilisation de la collection BalloonLabels

Pour renvoyer la collection BalloonLabels, utilisez la propriété Labels.

Pour renvoyer un objet BalloonLabel, utilisez Labels(index), index étant un nombre compris entre 1 et 5. Une info-bulle peut contenir un maximum de cinq étiquettes ; une étiquette apparaît quand une valeur est affectée à sa propriété Text.

L'exemple suivant montre comment créer une info-bulle contenant trois choix. La variable x se voit affecter la valeur renvoyée de la méthode Show, qui sera égale à 1, 2 ou 3, selon l'étiquette sur laquelle l'utilisateur clique. Cet exemple montre comment afficher la valeur de la variable x, mais vous pouvez passer la valeur à une autre procédure ou l'utiliser dans une instruction Select Case.

Set b = Assistant.NewBalloon

With b

    .Heading = "This is my heading"

    .Text = "Select one of these things:"

    .Labels(1).Text = "Choice One"

    .Labels(2).Text = "Choice Two"

    .Labels(3).Text = "Choice Three"

    x = .Show

End With

MsgBox x

Remarque

Les cases à cocher d'une info-bulle affichent les choix de l'utilisateur tant que ce dernier ne fait pas disparaître l'info-bulle. Les étiquettes de l'info-bulle enregistrent le choix de l'utilisateur dès que ce dernier clique sur un bouton situé à côté d'une étiquette.


BalloonLabel, objet

Représente une étiquette dans l'info-bulle du Compagnon Office. L'objet BalloonLabel est un membre de la collection BalloonLabels.

Utilisation de l'objet BalloonLabel

Pour renvoyer un objet BalloonLabel, utilisez Labels(index), index étant un nombre compris entre 1 et 5. Une info-bulle peut contenir un maximum de cinq étiquettes ; une étiquette apparaît quand une valeur est affectée à sa propriété Text.

L'exemple suivant montre comment créer une info-bulle qui demande à l'utilisateur de cliquer sur l'étiquette correspondant à son âge.

With Assistant.NewBalloon

    .Heading = "Check Your Age Group."

    .Labels(1).Text = "Under 30."

    .Labels(2).Text = "Over 30."

    .Labels(3).Text = "None of your business."

    .Text = "Which of the following " _

        & .Labels.Count & " choices apply to you?"

    .Show

End With

Remarque

Les cases à cocher d'une info-bulle affichent les choix de l'utilisateur tant que ce dernier ne fait pas disparaître l'info-bulle. Les étiquettes de l'info-bulle enregistrent le choix de l'utilisateur dès que ce dernier clique sur un bouton situé à côté d'une étiquette.


Add, méthode

Ajoute un objet à une collection. Choisissez l'une des collections suivantes pour afficher la description détaillée de la méthode Add correspondante.

CommandBarControls

CommandBars

DocumentProperties

PropertyTests


Add, méthode (collection CommandBarControls)

Crée un nouveau contrôle de barre de commandes et l'ajoute à la collection de contrôles de la barre de commandes spécifiée. Renvoie un objet CommandBarButton, CommandBarComboBox ou CommandBarPopup.

Syntaxe

expression.Add(Type, Id, Parameter, Before, Temporary)

expression   Obligatoire. Expression qui renvoie un objet CommandBarControls.

Type   Argument de type Variant facultatif. Type du contrôle à ajouter à la barre de commandes spécifiée. Il peut s'agir de l'une des constantes MsoControlType suivantes : msoControlButton, msoControlEdit, msoControlDropdown, msoControlComboBox ou msoControlPopup.

Id   Argument de type Variant facultatif. Entier qui identifie un contrôle intégré. Si la valeur de l'argument est égale à 1 ou si celui-ci est omis, un contrôle personnalisé vide du type indiqué est ajouté à la barre de commandes.

Parameter   Argument de type Variant facultatif. En cas de contrôles intégrés, l'application conteneur l'utilise pour exécuter la commande. En cas de contrôles personnalisés, cet argument peut servir à envoyer des informations à des procédures Visual Basic ou à stocker des informations sur le contrôle (semblable à une deuxième valeur de la propriété Tag).

Before   Argument de type Variant facultatif. Nombre qui indique la position du nouveau contrôle sur la barre de commandes. Le nouveau contrôle est inséré avant le contrôle déjà en place. Si vous ne spécifiez pas cet argument, le contrôle est ajouté à la fin de la barre de commandes.

Temporary   Argument de type Variant facultatif. Affectez-lui la valeur True s'il s'agit d'un contrôle temporaire. Les contrôles temporaires sont supprimés lors de la fermeture de l'application qui les contient. La valeur par défaut est False.


Add, méthode (collection CommandBarControls) - Exemple

Cet exemple montre comment ajouter un bouton dont l'image est celle du bouton intégré de création de graphiques à la barre de commandes intitulée « Custom », puis comment affecter la procédure « Analyze » à ce bouton.

Set custBar = CommandBars("Custom")

custBar.Visible = True

Set graphBtn = custBar.Controls.Add(Type:=msoControlButton)

graphBtn.FaceId = 17

graphBtn.OnAction = "Analyze"


Add, méthode (collection CommandBars)

Crée une nouvelle barre de commandes et l'ajoute à la collection de barres de commandes. Renvoie un objet CommandBar.

Syntaxe

expression.Add(Name, Position, MenuBar, Temporary)

expression   Obligatoire. Expression qui renvoie un objet CommandBars.

Name   Argument de type Variant facultatif. Nom de la nouvelle barre de commandes. Si vous ne spécifiez pas cet argument, Word assigne un nom par défaut à la barre de commandes (tel que « Personnalisé 1 »).

Position   Argument de type Variant facultatif. Position de la nouvelle barre de commandes. Il peut s'agir de l'une des constantes MsoBarPosition suivantes :

Constante	Description
msoBarLeft, msoBarTop, msoBarRight, msoBarBottom	Indique les coordonnées de gauche, du haut, de droite et du bas de la barre
msoBarFloating	Indique que la barre ne sera pas ancrée
msoBarPopup	Indique qu'il s'agit d'un menu contextuel
msoBarMenuBar	Sur Macintosh, indique que la nouvelle barre remplace le menu système
MenuBar   Argument de type Variant facultatif. Affectez-lui la valeur True pour remplacer la barre de menus active par la nouvelle barre de commandes. La valeur par défaut est False.

Temporary   Argument de type Variant facultatif. Affectez-lui la valeur True s'il s'agit d'une barre temporaire. Les barres de commandes temporaires sont supprimées lors de la fermeture de l'application. La valeur par défaut est False.


Add, méthode (collection CommandBars) - Exemple

Cet exemple montre comment ajouter une barre de commandes de niveau supérieur intitulée « Custom » qui ne sera pas sauvegardée en fin de session, et comment ajouter à la barre de commandes un bouton intégré destiné à la vérification orthographique.

Set mybar = CommandBars _

    .Add(Name:="Custom", Position:=msoBarTop, _

    Temporary:=True)

With mybar

    .Controls.Add Type:=msoControlButton, Id:=2

    .Visible = True

End With


Add, méthode (collection DocumentProperties)

Crée une nouvelle propriété de document personnalisée. Cette méthode ne s'applique que sur la collection de propriétés de document personnalisées.

Syntaxe

expression.Add(Name, LinkToContent, Type, Value, LinkSource)

expression   Obligatoire. L'objet DocumentProperties personnalisé.

Name   Argument de type String obligatoire. Nom de la propriété.

LinkToContent   Argument de type Boolean obligatoire. Indique si la propriété est liée au contenu du document ou non. Si l'argument a la valeur True, l'argument LinkSource est obligatoire ; s'il a la valeur False, l'argument Value est obligatoire.

Type   Argument de type Long obligatoire. Le type de données de la propriété. Il peut s'agir de l'une des constantes MsoDocProperties suivantes : msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber ou msoPropertyTypeString.

Value   Argument de type Variant facultatif. Valeur de la propriété si elle n'est pas liée au contenu du document. La valeur est convertie pour correspondre au type de données indiqué par l'argument Type, si c'est possible. Dans le cas contraire, une erreur se produit. Si l'argument LinkToContent a la valeur True, l'argument Value est ignoré et la nouvelle propriété de document prend la valeur par défaut jusqu'à ce que l'application conteneur mette à jour les valeurs de propriétés liées (normalement, lors de l'enregistrement du document).

LinkSource   Argument de type Boolean facultatif. Cet argument est ignoré si l'argument LinkToContent a la valeur False. La source de la propriété liée. Les types de liens utilisables sont déterminés par l'application conteneur.


Add, méthode (collection DocumentProperties) - Exemple

Cet exemple montre comment ajouter une nouvelle propriété de document personnalisée intitulée « Complete ». Il faut passer la collection DocumentProperties personnalisée à la procédure.

Sub AddCustomProperty(dp As DocumentProperties)

    dp.Add name:="Complete", linkToContent:=False, _

    type:=msoPropertyTypeBoolean, value:=False

End Sub


Add, méthode (collection PropertyTests)

Ajoute un objet PropertyTest à la collection PropertyTests.

Syntaxe

expression.Add(Name, Condition, Value, SecondValue, Connector)

expression   Expression qui renvoie un objet PropertyTests.

Name   Argument de type String obligatoire. Nom du critère de propriété. Ce nom correspond à l'une des valeurs de la zone Propriété de la boîte de dialogue Recherche approfondie.

Condition   Argument de type Variant obligatoire. Condition des critères de recherche. Il peut s'agir de l'une des constantes MsoCondition suivantes :

msoConditionAnyNumberBetween msoConditionAnytime msoConditionAnytimeBetween msoConditionAtLeast msoConditionAtMost msoConditionBeginsWith msoConditionDoesNotEqual msoConditionEndsWith msoConditionEquals msoConditionFileTypeAllFiles msoConditionFileTypeBinders msoConditionFileTypeDatabases msoConditionFileTypeExcelWorkbooks msoConditionFileTypeOfficeFiles msoConditionFileTypePowerPointPresentations msoConditionFileTypeTemplates msoConditionFileTypeWordDocuments msoConditionIncludesNearEachOther msoConditionIncludesPhrase msoConditionInTheLast	msoConditionInTheNext msoConditionIsExactly msoConditionIsNo msoConditionIsNot msoConditionIsYes msoConditionLastMonth msoConditionLastWeek msoConditionLessThan msoConditionMoreThan msoConditionNextMonth msoConditionNextWeek msoConditionOn msoConditionOnorAfter msoConditionOnorBefore msoConditionThisMonth msoConditionThisWeek msoConditionToday msoConditionTomorrow msoConditionYesterday
Value   Argument de type Variant facultatif. Valeur utilisée pour le critère de recherche.

SecondValue   Argument de type Variant facultatif. Valeur de la borne supérieure de la plage de recherche. Cet argument ne s'utilise que si Condition a la valeur msoConditionAnyTimeBetween ou msoConditionAnyNumberBetween.

Connector   Argument de type Variant facultatif. Indique le mode de combinaison de deux critères de recherche. Il peut s'agir de l'une des constantes msoConnector suivantes : msoConnectorAnd ou msoConnectorOr.


Add, méthode (collection PropertyTests) - Exemple

Cet exemple montre comment ajouter deux tests de propriété aux critères de recherche. Le premier test consiste à rechercher les fichiers qui sont des documents Word . Le second recherche les fichiers modifiés entre le 1er janvier 1996 et le 30 juin 1996.

Set fs = Application.FileSearch

fs.NewSearch

With fs.PropertyTests

    .Add Name:="Files of Type", _

        Condition:=msoConditionFileTypeWordDocuments, _

        Connector:= msoConnectorOr

    .Add Name:="Last Modified", _

        Condition:=msoConditionAnytimeBetween, _

        Value:="1/1/96", SecondValue:="30/6/96", _

        Connector:=msoConnectorAnd

End With


Copy, méthode

Copie le contrôle de barre de commandes spécifié dans une barre de commandes existante.

Syntaxe

expression.Copy(Bar, Before)

expression   Obligatoire. Une expression qui renvoie un objet CommandBarControl, CommandBarButton, CommandBarPopup ou CommandBarComboBox.

Bar   Argument de type Variant facultatif. Objet CommandBar qui représente la barre de commandes de destination. Si vous ne spécifiez pas cet argument, le contrôle est recopié sur sa barre d'origine.

Before   Argument de type Variant facultatif. Numéro qui indique la position du nouveau contrôle sur la barre de commandes indiquée. Le nouveau contrôle s'insère avant celui qui occupe déjà cette position dans la barre. Si vous ne spécifiez pas cet argument, le contrôle est copié en fin de barre.


Copy, méthode - Exemple

Cet exemple montre comment copier le premier contrôle de la barre de commandes intitulée « Standard » sur la barre « Custom » en le plaçant en première position. Un nouveau paramètre est ensuite affecté au contrôle, et ce dernier est sélectionné.

Set myCustomBar = CommandBars("Custom")

Set myControl = CommandBars("Standard").Controls(1)

With myControl

.Copy Bar:=myCustomBar, Before:=1

.Parameter = "2"

.SetFocus

End With


Count, propriété

Renvoie le nombre d'éléments de la collection spécifiée. Type de données Long en lecture seule.

Remarque

Pour la collection CommandBars, le nombre n'inclut que les barres de menus, barres d'outils et menus contextuels. Les menus et les sous-menus ne sont pas inclus.


Count, propriété - Exemples

Cet exemple montre comment afficher le nombre de barres de commandes de la collection au moyen de la propriété Count.

MsgBox "There are " & CommandBars.Count & " bars in your collection."

Cet exemple montre comment afficher le nombre de cases à cocher affichées dans la bulle Compagnon Office au moyen de la propriété Count.

With Assistant.NewBalloon

    .CheckBoxes(1).Text = "First Choice"

    .CheckBoxes(2).Text = "Second Choice"

    .Text = "You have the following " _

    & .CheckBoxes.Count & " choices."

    .Show

End With

Cet exemple montre comment afficher le nombre d'étiquettes affichées dans la bulle Compagnon Office au moyen de la propriété Count.

With Assistant.NewBalloon

    .Heading = "Check Your Age Group."

    .Labels(1).Text = "20 to 29"

    .Labels(2).Text = "30 to 39"

    .Labels(3).Text = "40 or over"

    .Text = "Which of the following " _

    & .Labels.Count & " choices apply to you?"

    .Show

End With

Cet exemple montre comment afficher le nombre de propriétés de document de la collection DocumentProperties qui ont été passées à la procédure.

Sub CountDocumentProperties(dp As DocumentProperties)

    MsgBox "There are " & dp.Count & " properties in the collection."

End Sub


Delete, méthode

Supprime l'objet spécifié de la collection qui le contient.

Syntaxe 1

expression.Delete

Syntaxe 2

expression.Delete(Temporary)

Syntaxe 3

expression.Delete(BstrQueryName)

expression   Obligatoire. Expression qui renvoie un objet CommandBar ou DocumentProperty (Syntaxe 1), un objet CommandBarControl (Syntaxe 2) ou un objet FileFind (Syntaxe 3).

Temporary   Argument de type Variant facultatif. Affectez-lui la valeur True pour supprimer le contrôle pour la session en cours. L'application affichera de nouveau le contrôle lors de la prochaine session.

BstrQueryName   Argument de type String obligatoire. Chaîne contenant jusqu'à 31 caractères qui indique le nom du critère de recherche à supprimer.

Remarque

Il n'est pas possible de supprimer une propriété de document intégrée.


Delete, méthode - Exemples

Cet exemple montre comment supprimer toutes les barres de commandes personnalisées qui ne sont pas visibles.

foundFlag = False

delBars = 0

For Each bar In CommandBars

    If (bar.BuiltIn = False) And _

    (bar.Visible = False) Then

        bar.Delete

        foundFlag = True

        delBars = delBars + 1

    End If

Next

If Not foundFlag Then

    MsgBox "No command bars have been deleted."

Else

    MsgBox delBars & " custom bar(s) deleted."

End If

Cet exemple montre comment supprimer une propriété de document personnalisée. Vous devez passer un objet DocumentProperty à la procédure.

Sub DeleteCustomDocumentProperty(dp As DocumentProperty)

    dp.Delete

End Sub


Execute, méthode

Exécute la procédure associée à un contrôle de barre de commandes ou démarre une recherche de fichiers. Choisissez l'un des objets suivants pour afficher la description détaillée de la méthode Execute de cet objet.

CommandBarButton

CommandBarControl

CommandBarPopup

CommandBarComboBox

FileSearch

FileFind


Execute, méthode (contrôles de barre de commandes)

Exécute la macro ou la commandes intégrée affectées au contrôle de barre de commandes spécifié. En cas de contrôles personnalisés, utilisez la propriété OnAction pour indiquer la macro à exécuter.

Syntaxe

expression.Execute

expression   Obligatoire. Une expression qui renvoie un objet CommandBarControl, CommandBarButton, CommandBarPopup ou CommandBarComboBox.


Execute, méthode (contrôles de barre de commandes) - Exemple

Cet exemple montre comment vérifier la valeur de la zone de liste modifiable de la barre de commandes personnalisée intitulée « My Command Bar ». Si la valeur est égale à « First », la macro indiquée par la propriété OnAction du contrôle est exécutée.

Set mycontrol = CommandBars("My Custom Bar").Controls(1)

With mycontrol

If .List(.ListIndex) = "First" Then

mycontrol.Execute

   End If

End With


Execute, méthode (objets FileSearch et FileFind)

Objet FileSearch : Démarre la recherche des fichiers spécifiés.

Objet FileFind : Démarre la recherche des fichiers spécifiés et met à jour la collection FindFileResults. Disponible uniquement sur Macintosh.

Syntaxe 1

expression.Execute(SortBy, SortOrder, AlwaysAccurate)

Syntaxe 2

expression.Execute

expression   Obligatoire. Expression qui renvoie un objet FileSearch (Syntaxe 1) ou un objet FileFind (Syntaxe 2).

SortBy   Argument de type Variant facultatif. La méthode utilisée pour trier les fichiers renvoyés. Il peut s'agir de l'une des constantes MsoSortBy suivantes : msoSortbyFileName, msoSortbyFileType, msoSortbyLastModified ou msoSortbySize.

SortOrder   Argument de type Variant facultatif. Ordre de tri des fichiers renvoyés. Il peut s'agir de l'une des constantes MsoSortOrder suivantes : msoSortOrderAscending ou msoSortOrderDescending.

AlwaysAccurate Argument de type Boolean facultatif. Affectez-lui la valeur True pour inclure dans la recherche les fichiers ajoutés, modifiés ou supprimés depuis la dernière mise à jour de l'index. La valeur par défaut est True.


Execute, méthode (objets FileSearch et FileFind) - Exemple

Cet exemple montre comment chercher tous les fichiers dont le nom commence par « cmd » dans le dossier Mes documents, puis comment afficher l'emplacement et le nom de chaque fichier trouvé. Les fichiers sont triés par nom de fichier alphabétiquement.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd*"

    If .Execute(SortBy:=msoSortbyFileName, _

            SortOrder:=msoSortOrderAscending) > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


SetFocus, méthode

Déplace la sélection sur le contrôle de barre de commandes spécifié de façon qu'il puisse recevoir les saisies du clavier. Le type de saisie clavier pouvant être adressé au contrôle dépend du type de contrôle.

Note   Si le contrôle n'est pas actif ou s'il n'est pas visible à partir de l'état en cours, la méthode échoue.

Syntaxe

expression.SetFocus

expression   Obligatoire. Expression qui renvoie un objet CommandBarControl, CommandBarButton, CommandBarPopup ou CommandBarComboBox.


SetFocus, méthode - Exemple

Cet exemple montre comment copier le quatrième contrôle de la barre de commandes personnalisée « My Custom Bar » et le recopier en première position sur cette même barre. Un nouveau paramètre est ensuite affecté au contrôle et ce dernier est sélectionné.

Set mycontrol = CommandBars("My Custom Bar") _

    .Controls(4)

With mycontrol

.Copy Before:=1

.Parameter = "2"

.SetFocus

End With


Text, propriété

Objet CommandBarComboBox : Renvoie ou définit le texte dans la zone d'affichage ou de modification de la zone de liste modifiable de la barre de commandes. Type de données String en lecture-écriture.

Objets BalloonLabel ou BalloonCheckbox : Renvoient ou définissent le texte affiché en regard de la case à cocher ou de l'étiquette spécifiées dans la bulle Compagnon Office. Type de données String en lecture-écriture.

Objet Balloon : Renvoie ou définit le texte affiché après le titre mais avant les étiquettes ou les cases à cocher dans la bulle Compagnon Office. Type de données String en lecture-écriture.

Objet FileFind : Renvoie ou définit la chaîne de caractères à rechercher (jusqu'à 80 caractères) dans le corps d'un document. Disponible uniquement sur Macintosh. Type de données String en lecture-écriture.

Remarque

Dans le cas des objets Balloon, BalloonLabel et BalloonCheckbox, vous pouvez demander l'affichage d'un graphisme en utilisant la syntaxe : {type location sizing_factor}, avec type égal à bmp (bitmap), wmf (Windows metafile) ou pict (Macintosh PICT), location étant l'identificateur de ressource ou le chemin d'accès suivi du nom de fichier, et sizing_factor la largeur du graphisme wmf ou pict (omis pour bmp).


Text, propriété - Exemples

Cet exemple montre comment vérifier le nombre d'éléments de la zone de liste modifiable de la barre de commandes intitulée « Custom ». La liste est supprimée si elle contient plus de trois éléments. Un nouveau premier élément nommé « Floyd » est ensuite ajouté.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls(2)

With myControl

    If .ListCount > 3 Then

        .Clear

        .AddItem "Floyd", 1

        .Text = "Floyd"

    End If

End With

Cet exemple montre comment créer une nouvelle bulle Compagnon Office avec un titre, du texte et trois cases à cocher correspondant à des choix de régions. L'exemple montre comment utiliser la propriété Text pour libeller chaque case.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With

Cet exemple montre comment créer une nouvelle bulle Compagnon Office avec un titre, du texte et trois cases à cocher correspondant à des choix de régions. L'exemple montre comment utiliser la propriété Text pour donner à l'utilisateur des instructions relatives à la bulle.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With


Top, propriété

Objets CommandBar ou CommandBarControl : Renvoient ou définissent la distance (en pixels) entre le bord supérieur de la barre de commandes ou du contrôle de barre de commandes spécifiés et le bord supérieur de l'écran. Dans le cas de barres de commandes ancrées, cette propriété renvoie ou définit la distance entre la barre de commandes et le haut de la zone d'ancrage. Type de données Long en lecture-écriture pour CommandBar. Type de données Long en lecture seule pour CommandBarControl.

Objet Assistant : Définit ou renvoie la position verticale de la fenêtre du Compagnon Office (en points) par rapport à l'écran. Type de données Integer en lecture-écriture.


Top, propriété - Exemples

Cet exemple montre comment positionner le coin supérieur gauche de la barre de commandes flottante intitulée « Custom » à 140 pixels du bord gauche et 100 pixels du haut de l'écran.

Set myBar = CommandBars("Custom")

myBar.Position = msoBarFloating

With myBar

    .Left = 140

    .Top = 100

End With

Cet exemple montre comment déplacer le Compagnon Office vers les coordonnées spécifiées.

Assistant.Top = 500


HelpContextId, propriété

Renvoie ou définit le numéro de contexte Aide correspondant à la rubrique d'aide rattachée au contrôle de barre de commandes. Type de données Long en lecture-écriture.

Remarque

Pour utiliser cette propriété, vous devez également affecter une valeur à la propriété HelpFile.


HelpContextId, propriété - Exemple

Cet exemple montre comment ajouter dans le menu Fichier un bouton correspondant à un gestionnaire de rapports personnalisé, puis lui affecter une rubrique d'aide contextuelle.

Set fileMenu = CommandBars _

    .FindControl(Type:=msoControlPopup, Id:=fileID)

Set fileMenuDropdown = fileMenu.CommandBar

Set newButton = fileMenuDropdown.Controls _

    .Add(Type:=msoControlButton, Before:=3)

With newButton

    .Caption = "Open Report"

    .DescriptionText = "Opens a quarterly report form"

    .OnAction = "ReportManager"

    .HelpFile = "C:\corphelp\custom.hlp"

    .HelpContextID = 47

End With


HelpFile, propriété

Renvoie ou définit le nom du fichier d'aide correspondant à la rubrique d'aide rattachée au contrôle de barre de commandes. Type de données String en lecture-écriture.

Remarque

Pour utiliser cette propriété, vous devez également définir la propriété HelpContextID.


HelpFile, propriété - Exemple

Cet exemple montre comment ajouter dans le menu Fichier un bouton correspondant à un gestionnaire de rapports personnalisé, puis comment lui affecter une rubrique d'aide contextuelle.

Set fileMenu = CommandBars _

   .FindControl(Type:=msoControlPopup, Id:=fileId)

Set fileMenuDropdown = fileMenu.CommandBar

Set newbutton = fileMenuDropdown.Controls _

    .Add(Type:=msoControlButton, Id:=customId, Before:=3)

With newButton

.Caption = "Open Report"

    .DescriptionText = "Opens a quarterly report form"

    .OnAction = "ReportManager"

.HelpFile = "C:\corphelp\custom.hlp"

    .HelpContextID = 47

End With


LargeButtons, propriété

Cette propriété a la valeur True en cas d'affichage de boutons agrandis. Type de données Boolean en lecture-écriture.


LargeButtons, propriété - Exemple

Cet exemple montre comment afficher des boutons agrandis et des info-bulles dans toutes les barres de commandes si la barre de menus principale qui est active est intitulée « Custom ».

Set allBars = CommandBars

If allBars.ActiveMenuBar.Name = "Custom" Then

    allBars.LargeButtons = True

    allBars.ShowToolTips = True

End If


List, propriété

Renvoie ou définit la valeur d'un élément de liste dans la zone de liste modifiable de la barre de commandes. Type de données String en lecture-écriture.

Note   Il s'agit d'une propriété en lecture seule dans le cas d'une zone de liste modifiable prédéfinie.

Syntaxe

expression.List(Index)

expression   Obligatoire. Expression qui renvoie un objet CommandBarComboBox.

Index   Argument de type Long obligatoire. Index de l'élément de la liste.


List, propriété - Exemple

Cet exemple montre comment vérifier la valeur du quatrième élément de la zone de liste modifiable intitulée « Vegetables » de la barre de commandes « Custom ». Si la valeur est « Tomato », le code spécifié par la propriété OnAction de la barre de commandes est exécuté.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls("Vegetables")

If myControl.List(4) = "Tomatoes" Then myControl.Execute


ListCount, propriété

Renvoie le nombre d'éléments de liste de l'objet zone de liste modifiable de la barre de commandes spécifiée. Type de données Long en lecture-écriture.


ListCount, propriété - Exemple

Cet exemple montre comment vérifier le nombre d'éléments de la zone de liste modifiable de la barre de commandes intitulée « Custom ». Si la liste comporte plus de trois éléments, elle est supprimée, un nouveau premier élément y est ajouté et s'affiche par défaut.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls(2)

With myControl

    If .ListCount > 3 Then

        .Clear

        .AddItem Text:="Floyd", Index:=1

        .ListIndex = 1

    End If

End With


ListHeaderCount, propriété

Renvoie ou définit le nombre d'éléments de liste de la zone de liste modifiable de barre de commandes qui sont situés au dessus de la ligne de séparation. Type de données Long en lecture-écriture.

Note   Il s'agit d'une propriété en lecture seule dans le cas d'une zone de liste modifiable prédéfinie.

Remarque

La valeur -1 pour la propriété ListHeaderCount indique que la zone de liste modifiable ne comporte pas de ligne de séparation.


ListHeaderCount, propriété - Exemple

Cet exemple montre comment ajouter une zone de liste modifiable à la barre de commandes intitulée « Custom », puis comment ajouter deux éléments à la liste ; une valeur est ensuite affectée au nombre de lignes d'éléments et à la largeur de la zone. Enfin, la valeur vide est affectée par défaut à la liste.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox)

With myControl

    .AddItem Text:="First Item", Index:=1

    .AddItem Text:="Second Item", Index:=2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 1

End With


ListIndex, propriété

Renvoie ou définit le numéro d'index de l'élément sélectionné dans la liste de la zone de liste modifiable de barre de commandes. La propriété renvoie la valeur zéro si aucun élément n'est sélectionné dans la liste. Type de données Long en lecture-écriture.

Note   Cette propriété échoue dans le cas de contrôles autres que des listes.

Remarque

L'affectation d'une valeur à la propriété ListIndex a pour effet de sélectionner l'élément correspondant du contrôle spécifié et d'exécuter l'action appropriée dans l'application.


ListIndex, propriété - Exemple

Cet exemple montre comment exécuter une procédure existante, en fonction de la sélection effectuée dans une zone de liste modifiable. L'intitulé de l'élément de liste n'a pas d'importance car c'est la propriété ListIndex ou le numéro d'index de l'élément qui détermine la procédure à exécuter.

With myControl

    Select Case .ListIndex

        Case 1

            chartcourse

        Case 2

            displaygraph

        Case Else

           MsgBox "invalid choice"

    End Select

End With


NameLocal, propriété

Renvoie le nom d'une barre de commandes intégrée tel qu'il est affiché dans la langue de l'application conteneur, ou renvoie ou définit le nom d'une barre de commandes personnalisée. Type de données String en lecture-écriture.

Note   Une erreur se produit si vous essayez d'affecter une valeur à cette propriété dans le cas d'une barre de commandes prédéfinie.

Remarques

Le nom local d'une barre de commandes intégrée s'affiche dans la barre de titre (quand la barre de commandes n'est pas ancrée) et dans la liste des barres de commandes disponibles, quel qu'en soit l'emplacement d'affichage dans l'application conteneur.

Si vous changez la valeur de la propriété NameLocal d'une barre de commandes personnalisée, la valeur de Name change également, et vice versa.


NameLocal, propriété - Exemple

Cet exemple montre comment afficher le nom et le nom local de la première barre de commandes de l'application.

With CommandBars(1)

    MsgBox "The name of the command bar is " & .Name

    MsgBox "The localized name of the command bar is " & .NameLocal

End With


OLEMenuGroup, propriété

Renvoie ou définit le groupe de menus auquel appartient le menu contextuel de barre de commandes lorsque les groupes de menus du serveur OLE sont fusionnés avec les groupes de menus d'un client OLE (c'est-à-dire, lorsqu'un objet de même type que l'application conteneur est incorporé dans une autre application). Il peut s'agir de l'une des constantes MsoOLEMenuGroup suivantes : msoOleMenuGroupNone, msoOleMenuGroupFile, msoOleMenuGroupEdit, msoOleMenuGroupContainer, msoOleMenuGroupObject, msoOleMenuGroupWindow ou msoOleMenuGroupHelp. Type de données Long en lecture-écriture.

Note   Cette propriété est en lecture seule dans le cas de contrôles prédéfinis.

Remarques

Le but de cette propriété est de permettre aux compléments de spécifier comment leurs contrôles de barre de commandes seront représentés dans l'application Office. Si le conteneur ou le serveur ne prend pas en charge les barres de commandes, une fusion normale de menu OLE a lieu : la barre de menus ainsi que les barres d'outils du serveur sont fusionnées, mais pas les barres d'outils du conteneur. Cette propriété ne s'applique qu'aux contrôles de menus contextuels de barre de menus, car les menus sont fusionnés en fonction de la catégorie de groupe de menus à laquelle ils appartiennent.

Si les deux applications qui fusionnent prennent en charge les barres de commandes, les contrôles de barre de commandes sont fusionnés en conformité avec la propriété OLEUsage.


OLEMenuGroup, propriété - Exemple

Cet exemple montre comment vérifier la propriété OLEMenuGroup d'un nouveau contrôle de menu contextuel personnalisé sur la barre de menus active, et comment lui affecter la valeur msoOLEMenuGroupNone.

Set myControl = ActiveMenuBar.Controls _

    .Add(Type:=msoControlPopup,Temporary:=False)

myControl.OLEMenuGroup = msoOLEMenuGroupNone


OLEUsage, propriété

Renvoie ou définit les rôles du client et du serveur OLE dans les cas où un contrôle de barre de commandes est utilisé lors du fusionnement de deux applications Microsoft Office. Il peut s'agir de l'une des constantes MsoControlOLEUsage suivantes : msoControlOLEUsageNeither, msoControlOLEUsageServer, msoControlOLEUsageClient ou msoControlOLEUsageBoth. Type de données Long en lecture-écriture.

Remarques

Le but de cette propriété est de vous permettre de spécifier comment les contrôles de barre de commandes des compléments seront représentés dans une application Office lorsque celle-ci est fusionnée avec une autre application Office. Si le client et le serveur prennent tous deux en charge les barres de commandes, les contrôles des barres de commandes sont incorporés un à un dans le client. Les contrôles personnalisés rattachés uniquement au client (ou ni au client, ni au serveur) sont supprimés du serveur. Les contrôles personnalisés rattachés uniquement au serveur (ou ni au serveur, ni au client) sont supprimés du client. Les contrôles restants sont fusionnés.

Si l'une des deux applications qui fusionnent n'est pas une application Office, une fusion normale de menu OLE a lieu, contrôlée par la propriété OLEMenuGroup.


OLEUsage, propriété - Exemple

Cet exemple montre comment ajouter un nouveau bouton à la barre de commandes intitulée Tools, et comment affecter une valeur à sa propriété OLEUsage.

Set myControl = CommandBars("Tools").Controls _

    .Add(Type:=msoControlButton,Temporary:=True)

myControl.OLEUsage = msoControlOLEUsageNeither


OnAction, propriété

Renvoie ou définit le nom de la macro Visual Basic exécutée si l'utilisateur clique sur le contrôle de barre de commandes ou change sa valeur. Type de données String en lecture-écriture.

Note   L'application conteneur détermine s'il s'agit d'un nom de macro valide.


OnAction, propriété - Exemple

Cet exemple montre comment ajouter un contrôle de barre de commandes à la barre intitulée « Custom » et spécifier que la macro intitulée « MySub » doit être exécutée sur simple clic du bouton.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls _

    .Add(Type:=msocontrolButton)

With myControl

    .FaceId = 2

    .OnAction = "MySub"

End With

myBar.Visible = True


Parameter, propriété

Renvoie ou définit une chaîne de caractères qu'une application peut utiliser pour exécuter une commande associée à un contrôle de barre de commandes. Type de données String en lecture-écriture.

Remarque

Si le paramètre spécifié est affecté à un contrôle prédéfini, l'application peut modifier son comportement par défaut si elle est capable d'analyser et d'utiliser la nouvelle valeur. Si le paramètre est affecté à un contrôle personnalisé, il peut être utilisé pour envoyer des informations à des procédures Visual Basic ou pour stocker des informations relatives au contrôle (équivaut à une seconde valeur de la propriété Tag).


Parameter, propriété - Exemple

Cet exemple montre comment copier le quatrième contrôle de la barre de commandes intitulée « Custom » et le coller sur cette même barre en première position. Un nouveau paramètre est affecté au nouveau bouton qui est ensuite sélectionné.

Set myControl = CommandBars("Custom").Controls(4)

With myControl

    .Copy , 1

    .Parameter = "2"

    .SetFocus

End With


PasteFace, méthode

Copie le contenu du Presse-papiers dans le bouton de barre de commandes spécifié.

Syntaxe

expression.PasteFace

expression   Obligatoire. Expression qui renvoie un objet CommandBarButton.


PasteFace, méthode - Exemple

Cet exemple montre comment rechercher le bouton prédéfini FileOpen et lui appliquer une image de bouton personnalisée provenant du Presse-papiers, où l'utilisateur vient de la modifier. La méthode échoue si le Presse-papiers ne contient pas d'image de bouton personnalisée ; utilisez la méthode CopyFace pour copier une image de bouton dans le Presse-papiers.

Set myControl = CommandBars.FindControl(Type:=msoControlButton, Id:=23)

myControl.PasteFace


Position, propriété

Renvoie ou définit la position de la barre de commandes spécifiée. Il peut s'agir de l'une des constantes MsoBarPosition suivantes : msoBarLeft, msoBarTop, msoBarRight, msoBarBottom, msoBarFloating, msoBarPopup ou msoBarMenu. Type de données Long en lecture-écriture.


Position, propriété - Exemple

Cet exemple montre comment parcourir la collection de barres de commandes en ancrant les barres personnalisées en bas de la fenêtre de l'application et les barres prédéfinies en haut.

For Each bar In CommandBars

    If bar.Visible = True Then

        If bar.BuiltIn Then

            bar.Position = msoBarTop

         Else

            bar.Position = msoBarBottom

        End If

    End If

Next


Priority, propriété

Renvoie ou définit la priorité du contrôle de barre de commandes spécifié. La priorité d'un contrôle détermine s'il peut être escamoté d'une barre de commandes ancrée si tous les contrôles ne tiennent pas sur une seule rangée. Type de données Long en lecture-écriture.

Remarques

Le contrôle ne peut pas être escamoté si sa priorité a la valeur 1. Les contrôles dont le numéro de priorité est le plus élevé sont escamotés les premiers.

Une priorité de 0 correspond à une valeur « automatique » qui choisira une priorité effective en fonction du type de contrôle considéré. Le contrôle ne sera jamais escamoté si sa priorité a la valeur 1. Les autres priorités valides vont de 2 à 7. Les contrôles sont escamotés dans l'ordre des numéros de priorité, en commençant par le numéro le plus élevé.


Priority, propriété - Exemple

Cet exemple montre comment déplacer la première zone de liste modifiable de la barre de commandes personnalisée intitulée « Custom » vers la position précédant le septième contrôle de cette même barre. Le libellé « selection box » est affecté à son étiquette et une priorité élevée est affectée au contrôle de sorte qu'il soit probablement escamoté si tous les contrôles ne tiennent pas sur une rangée.

Set allcontrols = CommandBars("Custom").Controls

For Each ctrl In allControls

    If ctrl.Type = msoControlComboBox Then

        With ctrl

            .Move Before:=7

            .Tag = "Selection box"

            .Priority = 5

        End With

    Exit For

End If

Next


Protection, propriété

Renvoie ou définit le type de protection anti-personnalisation associé à la barre de commandes spécifiée. Il peut s'agir de l'une ou de la somme des constantes MsoBarProtection suivantes : msoBarNoProtection, msoBarNoCustomize, msoBarNoResize, msoBarNoMove, msoBarNoChangeVisible, msoBarNoChangeDock, msoBarNoVerticalDock ou msoBarNoHorizontalDock. Type de données Long en lecture-écriture.


Protection, propriété - Exemple

Cet exemple montre comment parcourir la collection de barres de commandes à la recherche de la barre intitulée « Forms ». En cas de succès, cette dernière est affichée et son ancrage est protégé.

foundFlag = False

For i = 1 To CommandBars.Count

    If CommandBars(i).Name = "Forms" Then

            CommandBars(i).Protection = msoBarNoChangeDock

            CommandBars(i).Visible = True

            foundFlag = True

    End If

Next

If Not foundFlag Then

    MsgBox "'Forms' command bar is not in the collection."

End If


ReleaseFocus, méthode

Désactive la sélection de toutes les barres de commandes.

Syntaxe

expression.ReleaseFocus

expression   Obligatoire. Expression qui renvoie un objet CommandBars.


ReleaseFocus, méthode - Exemple

Cet exemple montre comment désactiver toutes les barres de commandes.

CommandBars.ReleaseFocus


RemoveItem, méthode

Supprime un élément de liste de la zone de liste modifiable de barre de commandes spécifiée.

Note   Cette propriété échoue dans le cas de contrôles autres que les zones de liste.

Syntaxe

expression.RemoveItem(Index)

expression   Obligatoire. Expression qui renvoie un objet CommandBarComboBox.

Index   Argument de type Long obligatoire. Élément à supprimer de la liste.


RemoveItem, méthode - Exemple

Cet exemple montre comment déterminer si la zone de liste modifiable intitulée « Combo1 » de la barre de commandes « Custom » contient plus de trois éléments. Si tel est le cas, le deuxième élément de la liste est supprimé, le style de la liste est modifié de sorte que son étiquette ne soit pas affichée, et une nouvelle valeur est affectée. La propriété Tag de l'objet parent (l'objet CommandBarControl) se voit affecter une valeur indiquant que la liste a été modifiée.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls("Combo1")

With myControl

    If .ListCount > 3 Then

        .RemoveItem 2

        .Style = msoComboNormal

        .Text = "New Default"

         Set ctrl = .Parent

         ctrl.Tag = "Contents Changed"

    End If

End With


Reset, méthode

Réinitialise la barre de commandes prédéfinie spécifiée en lui appliquant sa valeur de configuration de contrôle par défaut, ou réinitialise le contrôle de barre de commandes prédéfini spécifié en lui appliquant sa fonction et son image par défaut.

Syntaxe

expression.Reset

expression   Obligatoire. Expression qui renvoie un objet CommandBar, CommandBarControl, CommandBarButton, CommandBarPopup ou CommandBarComboBox.

Remarques

La réinitialisation d'un contrôle prédéfini rétablit les actions originellement prévues pour ce dernier et réinitialise chacune de ses propriétés à leur état initial. La réinitialisation d'une barre de commandes supprime les contrôles personnalisés et rétablit les contrôles prédéfinis.


Reset, méthode - Exemple

Cet exemple montre comment utiliser la valeurde la variable user pour adapter les barres de commandes selon le niveau de l'utilisateur. Si la valeur de utilisateur est « Level 1 », la barre de commandes intitulée « Custom » s'affiche. Si une autre valeur est affectée à utilisateur, la barre de commandes prédéfinie de Visual Basic est réinitialisée à son état par défaut et la barre de commandes intitulée « Custom » est désactivée.

Set myBar = CommandBars("Custom")

If user = "Level 1" Then

    myBar.Visible = True

Else

    CommandBars("Visual Basic").Reset

    myBar.Enabled = False

End If


RowIndex, propriété

Renvoie ou définit l'ordre d'ancrage de la barre de commandes spécifiée par rapport aux autres barres de la zone d'ancrage. Il peut s'agir d'un nombre entier supérieur à zéro, ou de l'une des constantes msoBarRow suivantes : msoBarRowFirst ou msoBarRowLast. Type de données Long en lecture-écriture.

Remarques

L'ordre d'ancrage commence par la barre associée au plus petit numéro. Plusieurs barres de commandes peuvent partager le même index de rangée. Si deux barres de commandes ou plus partagent le même index de rangée, la plus récente sera affichée en tête de son groupe.


RowIndex, propriété - Exemple

Cet exemple montre comment régler la position de la barre de commandes intitulée « Custom » en la déplaçant vers la gauche de 140 pixels de plus que la valeur par défaut, et comment l'ancrer en tête de rangée en affectant la valeur 1 à son index de rangée.

Set myBar = CommandBars("Custom")

With myBar

    .RowIndex = 1

    .Left = 140

End With


ShowPopup, méthode

Affiche la barre de commandes spécifiée sous la forme d'un menu contextuel selon les coordonnées indiquées ou selon celles du curseur.

Note   Si la valeur msoBarPopup n'est pas affectée à la propriété Position de la barre de commandes, cette méthode échoue.

Syntaxe

expression.ShowPopup(x, y)

expression   Obligatoire. Expression qui renvoie un objet CommandBar.

x  Argument de type Variant facultatif. Coordonnée x de l'emplacement du menu contextuel. Si vous ne spécifiez pas cet argument, la coordonnée x du curseur est utilisée.

y  Argument de type Variant facultatif. Coordonnée y de l'emplacement du menu contextuel. Si vous ne spécifiez pas cet argument, la coordonnée y du curseur est utilisée.


ShowPopup, méthode - Exemple

Cet exemple montre comment créer un menu contextuel contenant deux contrôles. La méthode ShowPopup affiche ce menu.

Set myBar = CommandBars _

    .Add(Name:="Custom1", Position:=msoBarPopup, Temporary:=False)

With myBar

    .Controls.Add Type:=msoControlButton, Id:=3

    .Controls.Add Type:=msoControlComboBox

End With

myBar.ShowPopup


State, propriété

Renvoie ou définit l'aspect du bouton de barre de commandes spécifié. Il peut s'agir de l'une des constantes MsoButtonState suivantes : msoButtonUp, msoButtonDown ou msoButtonMixed. Type de données Long en lecture-écriture.


State, propriété - Exemple

Cet exemple montre comment déterminer si le premier contrôle de la barre de commandes intitulée « Custom » a une image de bouton prédéfinie. Dans l'affirmative, l'exemple montre comment copier l'image du bouton dans le Presse-papiers afin qu'elle puisse être personnalisée au moyen d'une application telle que Microsoft Paint. La valeur msoButtonUp est affectée à l'état du bouton.

Set myControl = CommandBars("Custom").Controls(1)

With myControl

    If .BuiltInFace = True Then

        .CopyFace

    End If

    .State = msoButtonUp

End With


Style, propriété

Objet CommandBarButton : Renvoie ou définit le mode d'affichage du bouton de barre de commandes spécifié. Il peut s'agir de l'une des constantes MsoButtonStyle suivantes : msoButtonAutomatic, msoButtonIcon, msoButtonCaption ou msoButtonIconandCaption. Type de données Long en lecture-écriture.

Objet CommandBarComboBox : Renvoie ou définit le mode d'affichage de la zone de liste modifiable de barre de commandes spécifiée. Il peut s'agir de l'une des constantes MsoComboStyle suivantes : msoComboLabel ou msoComboNormal. Type de données Long en lecture-écriture.


Style, propriété - Exemple

Cet exemple montre comment créer un menu contextuel contenant un bouton et une zone de liste modifiable, et comment définir leur style.

Set myBar = CommandBars _

    .Add(Name:=" Custom1", Position:=msoBarPopup, Temporary:=False)

With myBar

    .Controls.Add Type:=msoControlButton, Id:=3

    .Controls(1).Style = msoButtonCaption

    .Controls.Add Type:=msoControlComboBox

    With .Controls(2)

        .Style = msoComboLabel

        .AddItem "vanilla"

        .AddItem "chocolate"

        .AddItem "cooking dough"

    End With

End With

myBar.ShowPopup


Tag, propriété

Renvoie ou définit des informations relatives au contrôle de barre de commandes spécifié : données pouvant être utilisées comme argument dans les procédures ou informations identifiant le contrôle. Type de données String en lecture-écriture.


Tag, propriété - Exemple

Cet exemple montre comment déplacer la première zone de liste modifiable d'une barre de commandes personnalisée intitulée « My Custom Bar » vers la position située avant le septième contrôle de la barre de commandes, comment affecter la valeur « Selection box » à son étiquette, puis lui affecter une priorité élevée afin qu'il puisse être retiré de la barre de commandes si tous les contrôles ne tiennent pas sur une ligne.

Set allControls = CommandBars("My Custom Bar").Controls

For Each ctrl In allControls

    If ctrl.Type = msoControlComboBox Then

        With ctrl

            .Move Before:=7

            .Tag = "Selection box"

            .Priority = 5

        End With

        Exit For

    End If

Next


TooltipText, propriété

Renvoie ou définit le texte affiché par l'info-bulle du contrôle de barre de commandes spécifié. Type de données String en lecture-écriture.

Remarque

Par défaut, la valeur de la propriété Caption est utilisée pour l'info-bulle.


TooltipText, propriété - Exemple

Cet exemple montre comment définir le dernier contrôle de la barre de menus active comme faisant partie d'un nouveau groupe et lui ajouter une info-bulle.

Set myMenuBar = CommandBars.ActiveMenuBar

Set lastCtrl = myMenuBar _

   .Controls(myMenuBar.Controls.Count)

With lastCtrl.BeginGroup = True

 TooltipText = "Click for help on UI feature"

End With


ActiveMenuBar, propriété

Renvoie un objet CommandBar qui représente la barre de menus active de l'application conteneur. En lecture seule.


ActiveMenuBar, propriété - Exemple

Cet exemple montre comment ajouter un menu contextuel provisoire intitulé « Custom » à la fin de la barre de menus active, puis comment ajouter un bouton intitulé « Import » dans la barre de commandes affichée par le contrôle.

Set myMenuBar = CommandBars.ActiveMenuBar

Set newMenu = myMenuBar.Controls.Add(Type:=msoControlPopup, Temporary:=True)

newMenu.Caption = "Custom"

Set ctrl1 = newMenu.CommandBar.Controls _

    .Add(Type:=msoControlButton, Id:=1)

With ctrl1

    .Caption = "Import"

    .TooltipText = "Import"

    .Style = msoButtonCaption

End With


AddItem, méthode

Ajoute un élément de liste à la zone de liste modifiable de barre de commandes spécifiée. Ce contrôle doit être personnalisé et correspondre à une liste déroulante ou à une liste modifiable.

Note   Cette méthode échouera si elle est appliquée à une zone de liste modifiable prédéfinie ou à une zone de modification.

Syntaxe

expression.AddItem(Text, Index)

expression   Obligatoire. Expression qui renvoie un objet  CommandBarComboBox.

Text   Argument de type String obligatoire. Élément à ajouter au contrôle spécifié.

Index   Argument de type Variant facultatif. Position de l'élément spécifié dans la liste d'éléments. Si vous ne spécifiez pas cet argument, l'élément est ajouté à la fin de la liste.


AddItem, méthode - Exemple

Cet exemple montre comment ajouter une zone de liste modifiable à la barre de commandes intitulée « Custom », puis ajouter deux éléments à la liste. L'exemple montre également comment définir le nombre d'éléments et la largeur de la zone de liste modifiable, et lui affecter par défaut une valeur vide.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox, Id:=1)

With myControl

    .AddItem "First Item", 1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


BeginGroup, propriété

Cette propriété a la valeur True si le contrôle de barre de commandes spécifié est placé au début d'un groupe de contrôles de la barre de commandes. Type de données Boolean en lecture-écriture.


BeginGroup, propriété - Exemple

Cet exemple montre comment définir le dernier contrôle de la barre de menus active comme premier contrôle d'un nouveau groupe.

Set myMenuBar = CommandBars.ActiveMenuBar

Set lastMenu = myMenuBar _

    .Controls(myMenuBar.Controls.Count)

lastMenu.BeginGroup = True


BuiltIn, propriété

Cette propriété a la valeur True si la barre de commandes ou le contrôle de barre de commandes spécifié sont prédéfinis à l'application conteneur. Cette propriété a la valeur False s'il s'agit d'un contrôle ou d'une barre de commandes personnalisée, ou s'il s'agit d'un contrôle prédéfini dont la propriété OnAction a été définie. Type de données Boolean en lecture seule.


BuiltIn, propriété - Exemple

Cet exemple montre comment supprimer toutes les barres de commandes personnalisées qui ne sont pas visibles.

foundFlag = False

deletedBars = 0

For Each bar In CommandBars

    If (bar.BuiltIn = False) And (bar.Visible = False) Then

        bar.Delete

        foundFlag = True

        deletedBars = deletedBars + 1

    End If

Next

If Not foundFlag Then

    MsgBox "No command bars have been deleted."

Else

    MsgBox deletedBars & custom command bar(s) deleted."

End If


BuiltInFace, propriété

Cette propriété a la valeur True si l'image du bouton de barre de commandes spécifié est son image prédéfinie. Il est seulement possible d'affecter la valeur True à cette propriété, ce qui rétablit l'image prédéfinie. Type de données Boolean en lecture-écriture.


BuiltInFace, propriété - Exemple

Cet exemple montre comment déterminer si l'image du premier contrôle de la barre de commandes intitulée « Custom » est son image prédéfinie. Si tel est le cas, l'image est copiée dans le Presse-papiers.

Set myControl = CommandBars("My Custom Bar").Controls(1)

With myControl

    If .BuiltInFace = True Then .CopyFace

End With


Caption, propriété

Renvoie ou définit le texte de légende du contrôle de barre de commandes spécifié. Type de données String en lecture-écriture.

Note   La légende d'un contrôle est également affichée dans son info-bulle par défaut.


Caption, propriété - Exemple

Cet exemple montre comment ajouter un contrôle de barre de commandes dont l'image est celle du bouton de vérification orthographique à une barre de commandes personnalisée, puis comment l'intituler « Spelling checker ».

Set myBar = CommandBars.Add(Name:="Custom", _

Position:=msoBarTop, Temporary:=True)

myBar.Visible = True

Set myControl = myBar.Controls _

.Add(Type:=msoControlButton, Id:=2)

With myControl

    .DescriptionText = "Starts the spelling checker"

    .Caption = "Spelling checker"

End With


Clear, méthode

Supprime tous les éléments de liste de la zone de liste modifiable de barre de commandes spécifiée (zone de liste déroulante ou zone de liste modifiable) et efface la zone de texte (zone de modification ou zone de liste modifiable).

Note   Cette méthode échouera si elle est appliquée à un contrôle de barre de commandes prédéfini.

Syntaxe

expression.Clear

expression   Obligatoire. Expression qui renvoie un objet  CommandBarComboBox.


Clear, méthode - Exemple

Cet exemple montre comment vérifier le nombre d'éléments de la zone de liste modifiable intitulée « Names » de la barre de commandes « Custom ». Si la liste comporte plus de trois éléments, elle est effacée, un nouveau premier élément y est ajouté et devient l'élément par défaut.

Set myBar = CommandBars("Custom Bar")

Set myControl = myBar.Controls("Names")

With myControl

    If .ListCount > 3 Then

        .Clear

        .AddItem Text:="Bendel", Index:=1

        .ListIndex = 1

    End If

End With


CommandBar, propriété

Renvoie un objet CommandBar qui représente le menu affiché par le menu contextuel spécifié. En lecture seule.


CommandBar, propriété - Exemple

Cet exemple montre comment affecter à la variable niveauTrois le quatrième contrôle de la barre de commandes intitulée « Drawing ».

Set niveauTrois = CommandBars("Drawing") _

    .Controls(1).CommandBar.Controls(4)


Controls, propriété

Renvoie un objet CommandBarControls qui représente tous les contrôles de la barre de commandes ou du menu contextuel spécifié. En lecture seule.

Pour plus d'informations sur le renvoi d'un seul membre d'une collection, consultez la rubrique Renvoi d'un objet à partir d'une collection.


Controls, propriété - Exemple

Cet exemple montre comment ajouter une zone de liste modifiable à une barre de commandes intitulée « Custom » et ajouter deux éléments à la liste. L'exemple montre également comment définir le nombre d'éléments et la largeur de la zone de liste modifiable, et lui affecter par défaut une valeur vide.

Set myControl = CommandBars("Custom").Controls _

    .Add(Type:=msoControlComboBox, Before:=1)

With myControl

    .AddItem Text:="First Item", Index:=1

    .AddItem Text:="Second Item", Index:=2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


CopyFace, méthode

Copie l'image du bouton de barre de commandes spécifié dans le Presse-papiers.

Syntaxe

expression.CopyFace

expression   Obligatoire. Expression qui renvoie un objet  CommandBarButton.

Remarque

La méthode PasteFace permet de coller le contenu du Presse-papiers sur l'image du bouton.


CopyFace, méthode - Exemple

Cet exemple montre comment trouver le bouton prédéfini Ouvrir et copier son image dans le Presse-papiers.

Set myControl = CommandBars.FindControl(Type:=msoControlButton, Id:=23)

myControl.CopyFace


DescriptionText, propriété

Renvoie ou définit la description du contrôle de barre de commandes spécifié. La description est affichée dans la barre d'état de l'application conteneur lorsque l'utilisateur positionne le curseur sur le contrôle de barre de commandes. Type de données String en lecture-écriture.

Remarque

Toutes les applications n'affichent pas une barre d'état. Cette propriété est également utilisée pour les bulles d'aide sur Macintosh.


DescriptionText, propriété - Exemple

Cet exemple montre comment ajouter un contrôle de barre de commandes dont l'image est celle du bouton de vérification orthographique dans une barre de commandes personnalisée. L'exemple montre également comment faire apparaître le texte « Starts the spelling checker » dans la barre d'état chaque fois que l'utilisateur positionne le curseur sur le bouton.

Set myBar = CommandBars.Add("Custom", msoBarTop, , True)

myBar.Visible = True

Set myControl = myBar.Controls _

.Add(Type:=msoControlButton, Id:=2)

With myControl

    .DescriptionText = "Starts the spelling checker"

    .Caption = "Spelling checker"

End With


DisplayTooltips, propriété

Cette propriété a la valeur True si des info-bulles sont affichées chaque fois que l'utilisateur positionne le curseur sur les contrôles de barre de commandes. Type de données  Boolean en lecture-écriture.

Remarque

La définition de la propriété DisplayTooltips dans une application conteneur affecte toutes les barres de commandes faisant partie de cette application, ainsi que celles de toute autre application Office 97 en cours d'exécution ou qui sera lancée ultérieurement, jusqu'à ce que la propriété soit modifiée à nouveau.


DisplayTooltips, propriété - Exemple

Cet exemple montre comment afficher des contrôles agrandis et des info-bulles pour toutes les barres de commandes dès lors que la barre de menus intitulée « Custom Menu Bar » est active.

Set allBars = CommandBars

If allBars.ActiveMenuBar.Name = "Custom Menu Bar" Then

    allBars.LargeButtons = True

    allBars.DisplayTooltips = True

End If


DropDownLines, propriété

Renvoie ou définit le nombre de lignes de la zone de liste modifiable de barre de commandes spécifiée. Ce contrôle doit être personnalisé et représenter une zone de liste déroulante ou une zone de liste modifiable. Type de données Long en lecture-écriture.

Note   Cette méthode échouera si elle est appliquée à une zone de liste modifiable prédéfinie ou à une zone de modification.

Remarque

Si la valeur 0 (zéro) est affectée à la propriété, le nombre de lignes du contrôle est basé sur le nombre d'éléments de la liste.


DropDownLines, propriété - Exemple

Cet exemple montre comment ajouter une zone de liste modifiable à la barre de commandes intitulée « Custom », puis ajouter deux éléments à la liste. L'exemple montre également comment définir le nombre d'éléments et la largeur de la zone de liste modifiable, et lui affecter par défaut une valeur vide.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox, Id:=1)

With myControl

    .AddItem Text:="First Item", Index:=1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


DropDownWidth, propriété

Renvoie ou affecte la largeur (en pixels) de la liste de la zone de liste modifiable de barre de commandes spécifiée. Type de données Long en lecture-écriture.

Note   Une erreur se produit en cas d'affectation d'une valeur à cette propriété pour une zone de liste modifiable prédéfinie.

Remarque

Si la valeur affectée à cette propriété est -1, la largeur de la liste est basée sur la longueur de son élément le plus long. Si la valeur affectée est égale à 0, la largeur de la liste est basée sur celle du contrôle.


DropDownWidth, propriété - Exemple

Cet exemple montre comment ajouter une zone de liste modifiable à la barre de commandes intitulée « Custom » et ajouter deux éléments à la liste. L'exemple montre également comment définir le nombre d'éléments et la largeur de la zone, et lui affecter par défaut une valeur vide.

Set myBar = CommandBars("Custom")

Set myControl = myBar.Controls.Add(Type:=msoControlComboBox, Id:=1)

With myControl

    .AddItem "First Item", 1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListHeaderCount = 0

End With


Enabled, propriété

Cette propriété a la valeur True si la barre de commandes ou le contrôle de barre de commandes spécifié est actif. Type de données Boolean en lecture-écriture.

Remarques

Dans le cas d'une barre de commandes, si vous affectez la valeur True à cette propriété, le nom de la barre s'affiche dans la liste des barres de commandes disponibles.

Dans le cas d'un contrôle prédéfini, si vous affectez la valeur True à la propriété Enabled, l'application détermine son état ; si vous lui affectez la valeur False, la propriété est désactivée.


Enabled, propriété - Exemples

Cet exemple montre comment adapter les barres de commandes selon le niveau de l'utilisateur spécifié par utilisateur. Si la valeur « Level 1 » est affectée à la variable user, la barre de commandes intitulée « VB Custom Bar » s'affiche. Si une autre valeur est affectée à utilisateur, la barre de commandes prédéfinie « Visual Basic » est réinitialisée à son état par défaut et la barre « VB Custom Bar » est désactivée.

Set myBar = CommandBars("VB Custom Bar")

If user = "Level 1" Then

    myBar.Visible = True

Else

    CommandBars("Visual Basic").Reset

    myBar.Enabled = False

End If

Cet exemple montre comment ajouter deux boutons à la barre de commandes représentée par la variable myBar. Le premier contrôle est désactivé et s'affiche en gris. Le second contrôle est activé par défaut.

With myBar

    .Controls.Add Type:=msoControlButton, Id:=3

    .Controls(1).Enabled = False

    .Controls.Add Type:=msoControlButton, Id:=3

End With

myBar.Visible = True


FaceId, propriété

Renvoie ou définit le numéro d'identification de l'image de bouton assignée au bouton de barre de commandes spécifié. Type de données Long en lecture-écriture.

Remarques

La propriété FaceId gère l'aspect mais pas la fonction d'un bouton de barre de commandes. La propriété Id de l'objet CommandBarControl détermine la fonction du bouton.

La valeur de la propriété FaceId pour un bouton de barre de commandes dont l'image est personnalisée est égale à 0 (zéro).


FaceId, propriété - Exemple

Cet exemple montre comment ajouter un bouton à une barre de commandes personnalisée. Cliquer sur ce bouton revient à cliquer sur la commande Ouvrir du menu Fichier car son numéro d'identification (ID) est 23, alors que le bouton a la même image que le bouton prédéfini Graphique. Un clic sur ce bouton affiche la boîte de dialogue Ouvrir.

Set newBar = CommandBars.Add(Name:="Custom2", _

     Position:=msoBarTop, Temporary:=True)

newBar.Visible = True

Set con = newBar.Controls.Add(Type:=msoControlButton, Id:=23)

con.FaceId = 17


FindControl, méthode

Renvoie un objet CommandBarControl qui correspond aux critères spécifiés.

Syntaxe

expression.FindControl(Type, Id, Tag, Visible, Recursive)

expression   Obligatoire. Expression qui renvoie un objet  CommandBars.

Type   Argument de type Variant facultatif. Type de contrôle à chercher. Il peut s'agir de l'une des constantes MsoControlType suivantes :

msoControlCustom msoControlButton msoControlEdit msoControlDropdown msoControlComboBox msoControlButtonDropdown msoControlSplitDropdown msoControlGenericDropdown msoControlGraphicCombo msoControlSplitButtonMRUPopup msoControlSplitExpandingGrid	msoControlGraphicDropdown msoControlPopup msoControlGraphicPopup msoControlButtonPopup msoControlGauge msoControlLabel msoControlExpandingGrid msoControlGrid msoControlOCXDropDown msoControlSplitButtonPopup
Id   Argument de type Variant facultatif. Numéro d'identification du contrôle à rechercher.

Tag   Argument de type Variant facultatif. Valeur de l'étiquette du contrôle à rechercher.

Visible   Argument de type Variant facultatif. Cet argument a la valeur True pour n'inclure dans la recherche que les contrôles des barres de commandes visibles. La valeur par défaut est False.

Recursive   Argument de type Boolean facultatif. Cet argument a la valeur True pour inclure dans la recherche les barres de commandes ainsi que toutes leurs barres de commandes contextuelles. La valeur par défaut est False.

Remarque

Si la collection CommandBars contient au moins deux contrôles qui correspondent aux critères de recherche, FindControl renvoie le premier contrôle trouvé. Si aucun contrôle ne correspond aux critères de recherche, FindControl renvoie Nothing. Aucun des arguments de la méthode FindControl n'a de valeur par défaut.


FindControl, méthode - Exemple

Cet exemple montre comment ajouter le bouton Enregistrer au menu Aide de la barre de menus. La méthode FindControl permet de trouver le menu Aide même si la barre de menus a été personnalisée par l'utilisateur.

Set helpMenu = CommandBars.FindControl _

    (Type:=msoControlPopup, Id:=helpId)

Set helpMenuDrop = helpMenu.Control.CommandBar

helpMenuDrop.Controls.Add Type:=msoControlButton, Id:=saveId


barre de commandes

Objet programmable utilisable dans Visual Basic pour contrôler un menu ou une barre d'outils. Tous les éléments suivants sont représentés par des objets CommandBar :

•	Barres de menus, barres d'outils et menus contextuels;

•	Menus faisant partie de barres de menus et de barres d'outils;

•	Sous-menus faisant partie de menus, sous-menus et menus contextuels.


contrôle de barre de commandes

Contrôle intégré ou personnalisé faisant partie d'une barre de menus, d'une barre d'outils, d'un sous-menu ou d'un menu contextuel. Les contrôles personnalisés que vous pouvez inclure dans les barres de commandes sont les suivants : boutons, zones de modification, listes déroulantes, zones de liste modifiable et menus contextuels (menus affichant un menu ou un sous-menu).


bouton

Bouton de barre d'outils ou élément de menu, de sous-menu ou de menu contextuel qui démarre l'exécution d'une commande quand il fait l'objet d'un clic. Les boutons de barre d'outils et les éléments de menu partagent les mêmes propriétés et méthodes.

Sur une barre d'outils, un bouton peut être affiché soit sous forme d'icône, soit sous forme d'icône avec légende, soit sous forme de légende uniquement. Sur un menu, un bouton s'affiche sous forme d'icône avec légende ou sous forme de légende uniquement.


zone de liste modifiable

Zone de modification, liste déroulante ou liste modifiable personnalisées faisant partie d'une barre de menus, d'une barre d'outils, d'un menu, d'un sous-menu ou d'un menu contextuel. Une zone de liste modifiable personnalisée peut être affichée avec ou sans légende. Si une barre d'outils est ancrée verticalement, les zones de liste modifiable qu'elle contient ne sont pas visibles.

De nombreux contrôles intégrés, tels que le bouton Annuler, sont également considérés comme des zones de liste modifiable ; cependant, nombre de propriétés et de méthodes servant à modifier les zones de liste modifiable ne sont pas disponibles pour ces contrôles intégrés.


zones de liste déroulante

Contrôle intégré ou personnalisé faisant partie d'une barre de menus ou d'une barre d'outils qui affiche un menu quand il fait l'objet d'un clic, ou élément de menu intégré ou personnalisé faisant partie d'un menu, d'un sous-menu ou d'un menu contextuel qui affiche un sous-menu quand le curseur est placé dessus.

De nombreux contrôles intégrés, tels que le bouton Couleur de police, sont eux aussi considérés comme des menus contextuels ; cependant, nombre de propriétés et de méthodes servant à modifier les menus contextuels ne sont pas disponibles pour ces contrôles intégrés.


CommandBars, collection d'objets

Collection d'objets CommandBar qui représentent les barres de commandes de l'application conteneur.

Utilisation de la collection CommandBars

La propriété CommandBars renvoie la collection CommandBars. L'exemple suivant montre comment afficher dans la fenêtre d'exécution le nom et le nom local de chaque barre de menus et d'outils, puis comment afficher une valeur qui indique si ces barres sont visibles.

For Each cbar in CommandBars

    Debug.Print cbar.Name, cbar.NameLocal, cbar.Visible

Next

La méthode Add ajoute une nouvelle barre de commandes à la collection. L'exemple suivant montre comment  créer une barre d'outils personnalisée intitulée « Custom1 » et l'afficher sous forme de barre d'outils flottante.

Set cbar1 = CommandBars.Add(Name:="Custom1", Position:=msoBarFloating)

cbar1.Visible = True

Pour renvoyer un objet CommandBar donné, spécifiez CommandBars(index), index étant le nom ou le numéro d'index d'une barre de commandes. L'exemple suivant montre comment ancrer la barre d'outils intitulée « Custom1 » en bas de la fenêtre de l'application.

CommandBars("Custom1").Position = msoBarBottom

Note   Vous pouvez utiliser un nom ou un numéro d'index pour spécifier une barre de menus ou d'outils faisant partie de la liste des barres de menus ou d'outils disponibles dans l'application conteneur. Toutefois, vous devez utiliser le nom pour spécifier un menu, un menu contextuel ou un sous-menu (ces menus sont représentés par des objets CommandBar). Si deux menus ou sous-menus personnalisés (ou plus) portent le même nom, CommandBars(index) renvoie le premier. Pour renvoyer le menu ou sous-menu correct, recherchez le menu contextuel correspondant et appliquez-lui la propriété CommandBar de façon à renvoyer la barre de commandes qui représente ce menu.


CommandBar, objet

Représente une barre de commandes de l'application conteneur. L'objet CommandBar est un membre de la collection CommandBars.

Utilisation de l'objet CommandBar

Pour renvoyer un objet CommandBar donné, spécifiez CommandBars(index), index étant le nom ou le numéro d'index d'une barre de commandes. L'exemple suivant montre comment rechercher dans la collection de barres de commandes la barre intitulée « Forms ». Si cette barre est trouvée, elle est rendue visible et son ancrage est protégé. Dans l'exemple qui suit, la variable cb représente un objet CommandBar.

foundFlag = False

For Each cb In CommandBars

    If cb.Name = "Forms" Then

        cb.Protection = msoBarNoChangeDock

        cb.Visible = True

        foundFlag = True

    End If

Next cb

If Not foundFlag Then

    MsgBox "The collection does not contain a Forms command bar."

End If

Vous pouvez utiliser un nom ou un numéro d'index pour spécifier une barre de menus ou d'outils faisant partie de la liste des barres de menus ou d'outils disponibles dans l'application conteneur. Toutefois, vous devez utiliser un nom pour spécifier un menu, un menu contextuel ou un sous-menu (ces menus sont représentés par des objets CommandBar). L'exemple suivant montre comment ajouter un nouvel élément de menu à la fin du menu Outils. Lorsque vous cliquez sur le nouvel élément de menu, la procédure « qtrReport » démarre.

Set newItem = CommandBars("Tools").Controls.Add(Type:=msoControlButton)

With newItem

    .BeginGroup = True

    .Caption = "Make Report"

    .FaceID = 0

    .OnAction = "qtrReport"

End With

Si deux menus ou sous-menus personnalisés (ou plus) portent le même nom, CommandBars(index) renvoie le premier. Pour renvoyer le menu ou sous-menu correct, recherchez le menu contextuel correspondant et appliquez-lui la propriété CommandBar de façon à renvoyer la barre de commandes qui représente ce menu.

En supposant que le troisième contrôle de la barre d'outils intitulée « Custom Tools » soit un menu contextuel, l'exemple suivant montre comment ajouter la commande Enregistrer à la fin de ce menu.

Set viewMenu = CommandBars("Custom Tools").Controls(3).CommandBar

viewMenu.Controls.Add ID:=3    'ID of Save command is 3


CommandBarControls, collection d'objets

Collection d'objets CommandBarControl qui représentent les contrôles de barre de commandes.

Utilisation d'une collection CommandBarControls

La propriété Controls renvoie la collection CommandBarControls spécifiée. L'exemple suivant montre comment changer les légendes des contrôles de la barre d'outils « Standard » de façon à leur affecter la valeur en cours de la propriété Id des contrôles.

For Each ctl In CommandBars("Standard").Controls

ctl.Caption = CStr(ctl.Id)

Next ctl

La méthode Add ajoute un nouveau contrôle de barre de commandes à la collection CommandBarControls. L'exemple suivant montre comment ajouter un nouveau bouton vide à la barre de commandes intitulée « Custom ».

Set myBlankBtn = CommandBars("Custom").Controls.Add

Pour renvoyer un objet CommandBarControl, CommandBarButton,, CommandBarComboBox ou CommandBarPopup, spécifiez Controls(index), index étant la légende ou le numéro d'index d'un contrôle. L'exemple suivant montre comment copier le premier contrôle d'une barre de commandes intitulée « Standard » sur une barre de commandes nommée « Custom ».

Set myCustomBar = CommandBars("Custom")

Set myControl = CommandBars("Standard").Controls(1)

myControl.Copy Bar:=myCustomBar, Before:=1


CommandBarControl, objet

Représente un contrôle de barre de commandes. L'objet CommandBarControl est un membre de la collection CommandBarControls. Les propriétés et méthodes de l'objet CommandBarControl sont partagées par les objets CommandBarButton, CommandBarComboBox et CommandBarPopup.

Note   Sous Visual Basic, lorsque vous écrivez du code associé à des barres de commandes personnalisées, vous utilisez les objets CommandBarButton, CommandBarComboBox et CommandBarPopup. Lorsque vous écrivez du code associé à des contrôles intégrés de l'application conteneur qui ne peuvent pas être représentés par l'un de ces trois objets, vous devez utiliser l'objet CommandBarControl.

Utilisation de l'objet CommandBarControl

Pour renvoyer un objet CommandBarControl, spécifiez Controls(index), index étant le numéro d'index d'un contrôle. (La propriété Type du contrôle doit être égale à msoControlLabel, msoControlExpandingGrid, msoControlSplitExpandingGrid, msoControlGrid ou msoControlGauge.)

Note   Les valeurs CommandBarButton, CommandBarComboBox et CommandBarPopup peuvent être affectées à des variables déclarées en tant que CommandBarControl.

La méthode FindControl peut aussi être utilisée pour renvoyer un objet CommandBarButton. L'exemple suivant montre comment chercher un contrôle de type msoControlGauge ; si un tel contrôle est trouvé, son numéro d'index et le nom de la barre de commandes qui le contient sont affichés. Dans l'exemple suivant, la variable lbl représente un objet CommandBarControl.

Set lbl = CommandBars.FindControl(Type:= msoControlGauge)

If lbl Is Nothing Then

    MsgBox "A control of type msoControlGauge was not found."

Else

    MsgBox "Control " & lbl.Index & " on command bar " _

        & lbl.Parent.Name & " is type msoControlGauge"

End If


CommandBarButton, objet

Représente un bouton sur une barre de commandes.

Utilisation de l'objet CommandBarButton

Pour renvoyer un objet CommandBarButton, spécifiez Controls(index), index étant le numéro d'index du contrôle. (La propriété  Type du contrôle doit être msoControlButton.)

En supposant que le second contrôle de la barre de commandes intitulée « Custom » soit un bouton, l'exemple suivant montre comment changer le style de ce bouton.

Set c = CommandBars("Custom").Controls(2)

With c

If .Type = msoControlButton Then

    If .Style = msoButtonIcon Then

        .Style = msoButtonIconAndCaption

    Else

        .Style = msoButtonIcon

    End If

End If

End With

La méthode FindControl peut aussi être utilisée pour renvoyer un objet CommandBarButton.


CommandBarComboBox, objet

Représente une zone de liste modifiable sur une barre de commandes.

Utilisation de l'objet CommandBarComboBox

Pour renvoyer un objet CommandBarComboBox, spécifiez Controls(index), index étant le numéro d'index du contrôle. (La propriété  Type du contrôle doit être égale à msoControlEdit, msoControlDropdown, msoControlComboBox, msoControlButtonDropdown, msoControlSplitDropdown, msoControlOCXDropdown, msoControlGraphicCombo ou msoControlGraphicDropdown.)

L'exemple suivant montre comment ajouter deux éléments au second contrôle de la barre de commandes intitulée « Custom » puis comment régler la taille du contrôle.

Set combo = CommandBars("Custom").Controls(2)

With combo

    .AddItem "First Item", 1

    .AddItem "Second Item", 2

    .DropDownLines = 3

    .DropDownWidth = 75

    .ListIndex = 0

End With

La méthode FindControl peut aussi être utilisée pour renvoyer un objet CommandBarButton. L'exemple suivant montre comment passer en revue toutes les barres de commandes à la recherche d'un objet CommandBarComboBox visible dont l'étiquette est « sheet assignments ».

Set myControl = CommandBars.FindControl _

(Type:=msoControlComboBox, Tag:=" sheet assignments", Visible:=True)


CommandBarPopup, objet

Représente un menu contextuel sur une barre de commandes.

Utilisation de l'objet CommandBarPopup

Pour renvoyer un objet CommandBarPopup, spécifiez Controls(index), index étant le numéro du contrôle. (La propriété Type du contrôle doit être égale à msoControlPopup, msoControlGraphicPopup, msoControlButtonPopup, msoControlSplitButtonPopup ou msoControlSplitButtonMRUPopup.)

La méthode FindControl peut aussi être utilisée pour renvoyer un objet CommandBarPopup. L'exemple suivant montre comment passer en revue toutes les barres de commandes à la recherche d'un objet CommandBarPopup dont l'étiquette est « Graphics ».

Set myControl = Application.CommandBars.FindControl _

(Type:=msoControlPopup, Tag:="Graphics")

Remarques

Tous les menus contextuels contiennent un objet CommandBar. Pour renvoyer la barre de commandes d'un menu contextuel, appliquez la propriété CommandBar à l'objet CommandBarPopup.


FileType, propriété

Objet FileSearch : renvoie ou définit le type de fichier à rechercher lors d'une opération de recherche. Il peut s'agir de l'une des constantes MsoFileType suivantes : msoFileTypeAllFiles, msoFileTypeBinders, msoFileTypeDatabases, msoFileTypeExcelWorkbooks, msoFileTypeOfficeFiles, msoFileTypePowerPointPresentations, msoFileTypeTemplates ou msoFileTypeWordDocuments. La valeur par défaut est msoFileTypeOfficeFiles. Type de données Variant en lecture-écriture.

Objet FileFind : renvoie ou définit le type de fichier à rechercher. Vous pouvez lui affecter la valeur renvoyée par la fonction MacId. Disponible uniquement sur Macintosh. Type de données Long en lecture-écriture.

Remarque

Pour renvoyer le type de fichier Macintosh approprié, utilisez les arguments énumérés ci-dessous en conjonction avec la fonction MacID.

Type de fichier	Argument
Document Word	MSWD
Classeur Microsoft Excel	XCEL
Présentation PowerPoint	PPT3 (quelle que soit la version de PowerPoint)
Fichier texte	TTXT


FileType, propriété - Exemple

Cet exemple montre comment rechercher tous les fichiers de type Classeur dans le dossier « My Documents » et afficher dans une boîte de message le nom et le chemin de chaque fichier trouvé.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileType = msoFileTypeBinders

    If .Execute > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " Binder file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no Binder files found."

    End If

End With


FoundFiles, propriété

Renvoie un objet FoundFiles qui contient les noms de tous les fichiers trouvés lors de la recherche. En lecture seule.


FoundFiles, propriété - Exemple

Cet exemple montre comment parcourir la liste des fichiers trouvés et afficher leur chemin.

With Application.FileSearch

For i = 1 To .FoundFiles.Count

    MsgBox .FoundFiles(i)

Next I

End With


LastModified, propriété

Renvoie ou définit une constante qui indique le temps qui s'est écoulé depuis la dernière modification et la dernière sauvegarde du fichier. Il peut s'agir de l'une des constantes msoLastModified suivantes : msoLastModifiedAnyTime, msoLastModifiedLastMonth, msoLastModifiedLastWeek, msoLastModifiedThisMonth, msoLastModifiedThisWeek, msoLastModifiedToday ou msoLastModifiedYesterday. La valeur par défaut est msoLastModifiedAnyTime. Type de données Variant en lecture-écriture.


LastModified, propriété - Exemple

Cet exemple montre comment définir les critères d'une recherche de fichier. Les fichiers renvoyés par cette recherche ont été récemment modifiés et se trouvent dans le dossier C:\Mes documents ou dans l'un de ses sous-dossiers.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .LastModified = msoLastModifiedYesterday

End With


LookIn, propriété

Renvoie ou définit le dossier sur lequel portera la recherche spécifiée. Type de données String en lecture-écriture.


LookIn, propriété - Exemple

Cet exemple montre comment rechercher dans le dossier « My Documents » tous les fichiers dont le nom commence par « Cmd », et comment afficher le nom et le chemin de chaque fichier trouvé.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd.*"

    If .Execute > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

        " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


MatchAllWordForms, propriété

Cette propriété a la valeur True si la recherche spécifiée porte sur toutes les formes du mot spécifié dans le corps du fichier ou dans ses propriétés. Type de données Boolean en lecture-écriture.

Remarque

Cette propriété est disponible uniquement si le fichier Mswds_en.lex a été installé et enregistré. Notez que ce fichier n'est pas installé dans le cadre d'une installation standard.


MatchAllWordForms, propriété - Exemple

Cet exemple montre comment renvoyer tous les fichiers dont le corps ou les propriétés contiennent le mot « run », « running », « runs » ou « ran ». La propriété TextOrProperty permet de définir le mot pouvant être associé et limite la recherche au corps du fichier ou à ses propriétés.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .TextOrProperty = "run"

    .MatchAllWordForms = True

    .FileType = msoFileTypeAllFiles

End With


MatchTextExactly, propriété

Cette propriété a la valeur True si la recherche spécifiée ne doit porter que sur les fichiers dont le corps de texte ou les propriétés contiennent exactement le mot ou la phrase spécifié. Type de données Boolean en lecture-écriture.


MatchTextExactly, propriété - Exemple

Cet exemple montre comment rechercher dans le dossier C:\Mes documents tous les fichiers dont le corps de texte ou les propriétés contiennent le mot « Run ».

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .TextOrProperty = "Run"

    .MatchTextExactly = True

    .FileType = msoFileTypeAllFiles

End With


NewSearch, méthode

Rétablit les valeurs par défaut de tous les critères de recherche.

Syntaxe

expression.NewSearch

expression   Obligatoire. Expression qui renvoie un objet FileSearch.

Remarque

Les valeurs des critères de recherche sont maintenues pour toute la durée d'une session. Utilisez cette méthode chaque fois que vous changez les critères de recherche ; notez qu'elle ne rétablit pas la valeur par défaut de la propriété LookIn.


NewSearch, méthode - Exemple

Cet exemple montre comment rétablir les critères de recherche par défaut au moyen de la méthode NewSearch avant de lancer une nouvelle recherche.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .FileName = "run"

    .MatchAllWordForms = True

    .FileType = msoFileTypeAllFiles

    If .Execute() > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

        " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


PropertyTests, propriété

Renvoie une collection PropertyTests qui contient tous les critères associés à une recherche. En lecture seule.

Pour plus d'informations sur le renvoi d'un seul membre à partir d'une collection, consultez la rubrique Renvoi d'un objet à partir d'une collection.


PropertyTests, propriété - Exemple

Cet exemple montre comment afficher tous les critères de recherche du premier test de propriété de la collection.

With Application.FileSearch.PropertyTests(1)

myString = "This is the search criteria: " _

    & " The name is: " & .Name & ". The condition is: " _

    & .Condition

If .Value <> "" Then

    myString = myString & ". The value is: " & .Value

    If .SecondValue <> "" Then

        myString = myString _

            & ". The second value is: " _

            & .SecondValue & ", and the connector is" _

            & .Connector

    End If

End If

MsgBox myString

End With


SearchSubFolders, propriété

Cette propriété a la valeur True si la recherche spécifiée porte sur tous les sous-dossiers du dossier spécifié par la propriété LookIn. Type de données Boolean en lecture-écriture.


SearchSubFolders, propriété - Exemple

Cet exemple montre comment rechercher dans le dossier « My Documents », ainsi que dans tous ses sous-dossiers, tous les fichiers dont le nom commence par « Cmd ». Il montre également comment afficher le nom et le chemin de chaque fichier trouvé.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .FileName = "cmd*"

    If .Execute() > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

     " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


TextOrProperty, propriété

Renvoie ou définit le mot ou la phrase à rechercher dans le corps de texte ou dans les propriétés du fichier lors de la recherche spécifiée. Le mot ou la phrase peut contenir le caractère générique * (astérisque) ou ? (point d'interrogation). Type de données String en lecture-écriture.

Remarques

Utilisez le point d'interrogation pour remplacer n'importe quel caractère. Par exemple, spécifiez gr?ve pour rechercher tous les fichiers qui contiennent au moins une fois « grave » ou « grive ».

Utilisez l'astérisque pour remplacer un nombre quelconque de caractères. Par exemple, spécifiez San* pour renvoyer tous les fichiers qui contiennent au moins un mot commençant par « San ».


TextOrProperty, propriété - Exemple

Cet exemple montre comment rechercher dans le dossier C:\Mes documents, ainsi que dans tous ses sous-dossiers, tous les fichiers dont le corps de texte ou les propriétés contiennent un ou plusieurs mots commençant par « San ». La propriété TextOrProperty définit le mot à rechercher et ne fait porter la recherche que sur le corps de texte ou sur les propriétés du fichier.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .TextOrProperty = "San*"

    .FileType = msoFileTypeAllFiles

End With


Connector, propriété

Renvoie le connecteur reliant deux valeurs de test de propriété semblables. Il peut s'agir de l'une des constantes MsoConnector suivantes : msoConnectorAnd ou msoConnectorOr. La valeur par défaut est msoConnectorAnd. Type de données Variant en lecture seule.

Remarque

Un connecteur spécifie si deux critères de recherche similaires doivent être combinés pour former un test de propriété (comme pour msoConnectorAnd), ou s'ils doivent être traités séparément (comme pour msoConnectorOr).


Connector, propriété - Exemple

Cet exemple montre comment afficher un message qui décrit le mode d'évaluation des critères lors de la recherche.

With Application.FileSearch.PropertyTests(1)

If .Connector = msoConnectorAnd Then

   MsgBox "All search criteria will be combined."

Else

    MsgBox "Criteria will be treated independently"

End If

End With


Condition, propriété

Renvoie la condition du critère de recherche spécifié. Type de données Variant en lecture seule.

Il peut s'agir de l'une des constantes MsoCondition suivantes :

msoConditionAnyNumberBetween msoConditionAnytime msoConditionAnytimeBetween msoConditionAtLeast msoConditionAtMost msoConditionBeginsWith msoConditionDoesNotEqual msoConditionEndsWith msoConditionEquals msoConditionFileTypeAllFiles msoConditionFileTypeBinders msoConditionFileTypeDatabases msoConditionFileTypeExcelWorkbooks msoConditionFileTypeOfficeFiles msoConditionFileTypePowerPointPresentations msoConditionFileTypeTemplates msoConditionFileTypeWordDocuments msoConditionIncludesNearEachOther msoConditionIncludesPhrase msoConditionInTheLast	msoConditionInTheNext msoConditionIsExactly msoConditionIsNo msoConditionIsNot msoConditionIsYes msoConditionLastMonth msoConditionLastWeek msoConditionLessThan msoConditionMoreThan msoConditionNextMonth msoConditionNextWeek msoConditionOn msoConditionOnorAfter msoConditionOnorBefore msoConditionThisMonth msoConditionThisWeek msoConditionToday msoConditionTomorrow msoConditionYesterday


Condition, propriété - Exemple

Cet exemple montre comment renvoyer la valeur de connexion des critères de recherche du premier test de propriété.

With Application.FileSearch.PropertyTests(1)

    MsgBox "The condition you've set is: " & .Condition

End With


SecondValue, propriété

Renvoie une deuxième valeur, facultative, de test de propriété (par exemple pour définir une plage) pour la recherche spécifiée. Type de données Variant en lecture seule.

Remarque

Cette propriété, qui a pour objet de spécifier une plage, ne peut être utilisée qu'avec les constantes MsoCondition suivantes : msoConditionAnyTimeBetween ou msoConditionAnyNumberBetween.


SecondValue, propriété - Exemple

Cet exemple montre comment afficher dans une boîte de dialogue la deuxième valeur du critère de recherche, s'il y en a une. Un message différent est affiché s'il n'y a pas de deuxième valeur.

With Application.FileSearch.PropertyTests(1)

If .SecondValue = "" Then

   MsgBox "You haven't specified a second value."

Else

    MsgBox "The second value you've set is: " _

    & .SecondValue

End If

End With


Remove, méthode

Supprime un objet PropertyTests de la collection PropertyTests.

Syntaxe

expression.Remove (lndex)

expression   Obligatoire. Expression qui renvoie un objet PropertyTests.

lndex   Argument de type Long obligatoire. Numéro d'index du test de propriété à supprimer.


Remove, méthode - Exemple

Cet exemple montre comment supprimer le premier critère de recherche de la collection.

Application.FileSearch.PropertyTests.Remove(1)


FileSearch, objet

Représente la boîte de dialogue Ouvrir (menu Fichier).

Utilisation de l'objet FileSearch

Pour renvoyer l'objet FileSearch, utilisez la propriété FileSearch. L'exemple qui suit montre comment rechercher les fichiers spécifiés et afficher à la fois le nombre de fichiers trouvés et le noms de chacun de ces fichiers.

With Application.FileSearch

    If .Execute() > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With

Pour rétablir les valeurs par défaut des critères de recherche, utilisez la méthode NewSearch. Les valeurs de propriété définies sont conservées une fois la recherche spécifiée terminée et, à l'aide de la méthode NewSearch, vous pouvez les redéfinir individuellement sans repasser par leur valeur par défaut. L'exemple qui suit montre comment réinitialiser les critères de recherche à leur valeur par défaut avant de lancer une nouvelle recherche.

With Application.FileSearch

    .NewSearch

    .LookIn = "C:\My Documents"

    .SearchSubFolders = True

    .FileName = "Run"

    .MatchTextExactly = True

    .FileType = msoFileTypeAllFiles

End With


PropertyTest, objet

Représente un critère de recherche unique. Les critères de recherche sont répertoriés dans la boîte de dialogue Recherche approfondie (menu Fichier, commande Ouvrir, bouton Approfondir). L'objet PropertyTest est un membre de la collection PropertyTests.

Utilisation de l'objet PropertyTest

Pour renvoyer un objet PropertyTests unique, utilisez PropertyTests(index), index étant le numéro d'index. L'exemple qui suit montre comment afficher tous les critères de recherche du premier test de propriété de la collection PropertyTests.

With Application.FileSearch.PropertyTests(1)

myString = "This is the search criteria: " _

    & " The name is: " & .Name & ". The condition is: " _

    & .Condition

If .Value <> "" Then

    myString = myString & ". The value is: " & .Value

    If .SecondValue <> "" Then

        myString = myString _

            & ". The second value is: " _

            & .SecondValue & ", and the connector is" _

            & .Connector

    End If

End If

MsgBox myString

End With


PropertyTests, collection d'objets

Collection d'objets PropertyTest qui contient tous les critères définis pour une recherche. Les critères de recherche sont répertoriés dans la boîte de dialogue Recherche approfondie (menu Fichier, commande Ouvrir, bouton Approfondir).

Utilisation de la collection PropertyTests

Pour renvoyer la collection PropertyTests, utilisez la propriété PropertyTests. L'exemple qui suit montre comment afficher le nombre de critères de recherche approfondie utilisés pour une recherche.

FileSearch.PropertyTests.Count

Pour ajouter un nouvel objet PropertyTests dans la collection PropertyTests, utilisez la méthode Add. L'exemple qui suit montre comment ajouter deux tests de propriété aux critères de recherche. Le première critère spécifie que les fichiers à rechercher doivent être des documents Word et le deuxième qu'ils doivent avoir été modifiés entre le 1er janvier 1996 et le 30 juin 1996.

Set fs = Application.FileSearch

fs.NewSearch

With fs.PropertyTests

    .Add Name:="Files of Type", _

    Condition:=msoConditionFileTypeWordDocuments, _

 Connector:=msoConnectorOr

    .Add Name:="Last Modified", _

    Condition:=msoConditionAnytimeBetween, _

    Value:="1/1/96", SecondValue:= "6/30/96", _

    Connector:=msoConnectorAnd

End With

Pour renvoyer un objet PropertyTests unique, utilisez PropertyTests(index), index étant le numéro d'index. L'exemple qui suit montre comment afficher tous les critères du premier test de propriété de la collection PropertyTests.

With Application.FileSearch.PropertyTests(1)

myString = "This is the search criteria: " _

    & " The name is: " & .Name & ". The condition is: " _

    & .Condition

If .Value <> "" Then

    myString = myString & ". The value is: " & .Value

    If .SecondValue <> "" Then

        myString = myString _

            & ". The second value is: " _

            & .SecondValue & ", and the connector is" _

            & .Connector

    End If

End If

MsgBox myString

End With


FoundFiles, objet

Représente la liste des fichiers renvoyés par une recherche.

Utilisation de l'objet FoundFiles

Pour renvoyer l'objet FoundFiles, utilisez la propriété FoundFiles. Cet exemple montre comment parcourir la liste des fichiers trouvés et afficher le chemin et le nom de chacun d'eux.

With Application.FileSearch

    For i = 1 To .FoundFiles.Count

        MsgBox .FoundFiles(i)

    Next I

End With

Pour renvoyer le chemin et le nom des fichiers trouvés utilisez FoundFiles(index), index étant le numéro d'index. L'exemple qui suit montre comment parcourir la collection des fichiers trouvés et afficher leur chemin et leur nom.

With Application.FileSearch

For i = 1 To .FoundFiles.Count

    MsgBox .FoundFiles(i)

Next I

End With

Pour lancer la recherche et mettre à jour l'objet FoundFiles, utilisez la méthode Execute. L'exemple qui suit montre comment rechercher dans le dossier « My Documents » tous les fichiers dont le nom commence par « Cmd » et afficher le nom et le chemin des fichiers trouvés. Cet exemple montre également comment trier les noms des fichiers alphabétiquement.

Set fs = Application.FileSearch

With fs

    .LookIn = "C:\My Documents"

    .FileName = "cmd*"

    If .Execute(SortBy:=msoSortbyFileName, _

    SortOrder:=msoSortOrderAscending) > 0 Then

        MsgBox "There were " & .FoundFiles.Count & _

            " file(s) found."

        For i = 1 To .FoundFiles.Count

            MsgBox .FoundFiles(i)

        Next i

    Else

        MsgBox "There were no files found."

    End If

End With


DocumentProperties, collection d'objets

Collection d'objets DocumentProperty. Chaque objet DocumentProperty correspond à une propriété prédéfinie ou personnalisée d'un document conteneur.

Utilisation de la collection DocumentProperties

Pour renvoyer une collection DocumentProperties qui contient toutes les propriétés prédéfinies d'un document conteneur, utilisez la propriété BuiltinDocumentProperties. Pour renvoyer une collection DocumentProperties qui contient toutes les propriétés personnalisées d'un document conteneur, utilisez la propriété CustomDocumentProperties.

Pour créer une nouvelle propriété personnalisée et l'ajouter à la collection DocumentProperties, utilisez la méthode Add. Cette méthode ne permet pas de créer une propriété de document prédéfinie.

Pour renvoyer un objet DocumentProperty donné qui correspond à une propriété de document prédéfinie spécifique, utilisez BuiltinDocumentProperties(index), index étant le numéro d'index de la propriété de document prédéfinie. Pour renvoyer un objet DocumentProperty donné qui correspond à une propriété de document personnalisée spécifique, utilisez CustomDocumentProperties(index), index étant le numéro d'index de la propriété de document personnalisée.


DocumentProperty, objet

Représente une propriété de document personnalisée ou prédéfinie d'un document conteneur. L'objet DocumentProperty fait partie de la collection DocumentProperties.

Utilisation de l'objet DocumentProperty

Pour renvoyer un objet DocumentProperty donné qui correspond à une propriété de document prédéfinie spécifique, utilisez BuiltinDocumentProperties(index), index étant le nom ou le numéro d'index de la propriété de document prédéfinie. Pour renvoyer un objet DocumentProperty donné qui correspond à une propriété de document personnalisée spécifique, utilisez CustomDocumentProperties(index), index étant le nom ou le numéro d'index de la propriété de document personnalisée.

La liste ci-dessous répertorie les noms de toutes les propriétés de document prédéfinies disponibles.

Title Subject Author Keywords Comments Template Last Author Revision Number Application Name Last Print Date Creation Date Last Save Time Total Editing Time Number of Pages	Number of Words Number of Characters Security Category Format Manager Company Number of Bytes Number of Lines Number of Paragraphs Number of Slides Number of Notes Number of Hidden Slides Number of Multimedia Clips
Les applications conteneur ne définissent pas nécessairement une valeur pour chacune des propriétés de document prédéfinies. Lorsqu'une application donnée ne définit pas de valeur pour l'une de ces propriétés, le renvoi de la propriété Value de cette propriété de document prédéfinie occasionne une erreur.


LinkToContent, propriété

Cette propriété a la valeur True si la valeur de la propriété de document personnalisée spécifiée est liée au contenu du document conteneur. Elle a la valeur False si la valeur est statique. Type de données Boolean en lecture-écriture.

Remarques

Cette propriété ne s'applique qu'aux propriétés de document personnalisées. Elle a toujours la valeur False pour les propriétés de document prédéfinies.

Pour définir la source de la propriété de document liée spécifiée, utilisez la propriété LinkSource. Si vous définissez la propriété LinkSource, la propriété LinkToContent se voit affecter la valeur True.


LinkToContent, propriété - Exemple

Cet exemple montre comment afficher l'état de liaison d'une propriété de document personnalisée. Il ne fonctionne que si dp est un objet DocumentProperty valide.

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "not "

    End If

    stat = "This property is " & tf & "linked"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "The link source is " & dp.LinkSource

    End If

    MsgBox stat

End Sub


LinkSource, propriété

Renvoie ou définit la source de la propriété de document personnalisée liée spécifiée. Type de données String en lecture-écriture.

Remarques

Cette propriété ne s'applique qu'aux propriétés de document personnalisée, et non aux propriétés de document prédéfinies.

La source de la liaison spécifiée est définie par l'application conteneur.

Si vous définissez la propriété LinkSource, la propriété LinkToContent se voit affecter la valeur True.


LinkSource, propriété - Exemple

Cet exemple montre comment afficher l'état de liaison d'une propriété de document personnalisée. Il ne fonctionne que si dp est un objet DocumentProperty valide.

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "not "

    End If

    stat = "This property is " & tf & "linked"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "The link source is " & dp.LinkSource

    End If

    MsgBox stat

End Sub


Value, propriété

Avec un objet DocumentProperty, renvoie ou définit la valeur de la propriété de document spécifiée. Type de données Variant en lecture-écriture.

Avec un objet PropertyTest, renvoie ou définit la valeur d'un test de propriété lors d'une recherche. Type de données Variant en lecture seule.

Remarques

Lorsqu'une application conteneur ne définit pas de valeur pour l'une des propriétés de document prédéfinies, la lecture de la propriété Value de cette propriété de document provoque une erreur.


Value, propriété - Exemples

Cet exemple montre comment afficher le nom, le type et la valeur d'une propriété de document. Il ne fonctionne que si dp est un objet DocumentProperty valide.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub

Cet exemple montre comment afficher dans une boîte de dialogue la deuxième valeur du critère de recherche, s'il y en a une. Il montre également comment afficher un message différent s'il n'y a pas de deuxième valeur.

With Application.FileSearch.PropertyTests(1)

If .Value = "" Then

   MsgBox "You haven't specified a value."

Else

    MsgBox "The value you've set is: " _

    & .Value

End If

End With


Le Compagnon Office

Microsoft Office 97 propose un nouveau type d'aide : le Compagnon Office. Celui-ci, de même que sa bulle d'aide ainsi que tous les éléments contenus dans cette dernière, est contrôlé par programmation au moyen des objets, des propriétés et des méthodes de l'objet Assistant.

Le Compagnon Office ainsi que sa bulle d'aide et tous les objets programmables qu'elle contient sont illustrés ci-dessous.

Pour plus d'informations sur la modification du Compagnon Office en cours de création ou d'exécution, consultez les rubriques :

Utilisation du Compagnon Office

Création et modification de bulles

Modification de bulles en cours d'exécution


Utilisation du Compagnon Office

Par l'intermédiaire du Compagnon Office, vous pouvez offrir à vos utilisateurs de l'aide sur des aspects spécifiques de votre application et affecter vos propres procédures aux contrôles de sa bulle d'aide.

Dans Visual Basic, tous les éléments associés au Compagnon Office sont représentés par l'objet Assistant et les objets qu'il contient. Les modifications que vous pouvez apporter au Compagnon en cours d'exécution sont les mêmes que celles que vous pouvez effectuer au moment de la création en cliquant sur le bouton droit de la souris. Toutes les options énumérées dans l'onglet Options de la boîte de dialogue Compagnon Office correspondent aux propriétés du Compagnon pouvant être définies en cours d'exécution. Le tableau ci-dessous répertorie les propriétés généralement utilisées pour modifier le Compagnon Office.

Propriété	Description
Animation	Anime le Compagnon Office. Certaines animations sont permanentes, d'autres n'apparaissent qu'une seule fois.
FileName	Spécifie le nom de fichier du Compagnon Office, y compris son extension .act. Clippit.act, par exemple, est le nom de fichier du Compagnon Clippit.
Name	Renvoie le nom du Compagnon Office. Cette propriété permet de savoir quels Compagnons Office l'utilisateur a sélectionnés.
Visible	Spécifie si le Compagnon est visible ou masqué.
L'exemple qui suit montre comment sélectionner le Compagnon William, le rendre visible et lui affecter une animation. Il montre aussi comment affecter une valeur à quelques unes des propriétés personnalisées de l'aide qui sont proposées sous l'onglet Options de la boîte de dialogue Compagnon Office au moment de la création.

With Assistant

    .FileName = "Will.act"

    .Animation = msoAnimationBeginSpeaking

    .AssistWithHelp = True

    .GuessHelp = True

    .FeatureTips = False

    .Visible = True

End With

Vous pouvez installer jusqu'à neuf acteurs Compagnon Microsoft Office différents, mais vous ne pouvez en activer qu'un seul à la fois. Votre application peut être programmée de sorte que le Compagnon soit choisi par l'utilisateur, ou vous pouvez en sélectionner un vous-même en cours d'exécution. Les fichiers des acteurs Compagnon installés ne sont pas modifiables et ne peuvent pas être remplacés par les fichiers de vos propres acteurs.


Création et modification de bulles

La bulle du Compagnon Office sert à fournir des informations à l'utilisateur. Ces informations peuvent consister en un simple message, en une demande d'informations complémentaires ou en une liste d'options. Les modifications portant sur la bulle d'aide du Compagnon Office doivent être effectuées en cours d'exécution.

Le tableau ci-dessous répertorie les propriétés et méthodes les plus usitées pour modifier l'apparence ou la fonction d'une nouvelle bulle d'aide (vide) ou d'une bulle existante. Les modifications apportées à une bulle donnée s'affichent à la prochaine application de la méthode Show à cette bulle.

Propriété ou méthode	Description
Heading	Spécifie le texte en gras qui s'affiche en haut de la bulle du Compagnon Office.
Text	Spécifie le texte qui s'affiche dans le corps de texte de la bulle du Compagnon Office. Il est placé sous le titre, mais avant les cases à cocher, les étiquettes ou les boutons.
Labels	Renvoie la collection d'étiquettes de la bulle. Le format des étiquettes est défini par la propriété BalloonType. Les étiquettes s'affichent au-dessous du texte de la bulle. Elles peuvent se présenter sous forme de liste numérotée ou à puces, ou sous forme de boutons. Dans le cas de boutons, le choix de l'utilisateur est enregistré dès qu'il clique sur un bouton donné, ce qui n'est pas le cas avec des cases à cocher.
Checkboxes	Renvoie la collection de cases à cocher de la bulle. L'utilisateur coche la case, puis clique sur le bouton approprié au bas de la bulle (OK ou Suivant, par exemple) pour enregistrer son choix.
Close	Ferme et fait disparaître une bulle non modale sans libérer la variable objet à laquelle elle est affectée. Cette variable est toujours valide et la bulle qu'elle représente peut encore être affichée, ou modifiée et affichée ultérieurement. Cette méthode n'est applicable qu'aux bulles non modales.
Show	Affiche la bulle et tous les objets qu'elle contient. N'utilisez cette méthode qu'avec des objets Balloon. Avec un objet Assistant, utilisez la propriété Visible.
L'exemple qui suit montre comment créer une bulle qui aide l'utilisateur à sélectionner une imprimante. Il montre également comment proposer une case à cocher donnant aux utilisateurs l'option de sauter les informations contenues dans la bulle.

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Printer."

    .Text = "Click OK when you've chosen a printer."

    lblTxt = "From the File menu, choose Print."

    .Labels(1).Text = lblTxt

    .Labels(2).Text = "Click Setup."

    .Labels(3).Text = "Select the name of the printer."

    .Checkboxes(1).Text = "Skip this information."

    .BalloonType = msoBalloonTypeNumbers

    .Mode = msoModeModal

    .Button = msoButtonSetOK

    .Show

End With

Création de bulles

Pour créer une nouvelle bulle, utilisez la propriété NewBalloon de l'objet Assistant. La bulle nouvellement créée est vide. Ajoutez un titre à l'aide de la propriété Heading, du texte à l'aide de la propriété Text, et, au besoin, ajoutez également des contrôles. Enfin, affichez la bulle à l'aide de la méthode Show. La bulle s'affiche avec les attributs qui ont été affectés aux propriétés. C'est pourquoi il est conseillé de n'utiliser cette méthode qu'une fois toutes les autres propriétés de la bulle définies. L'exemple qui suit montre comment créer une nouvelle bulle, en définir le titre et le corps de texte, et créer trois contrôles de type case à cocher que l'utilisateur peut sélectionner.

With Assistant.NewBalloon

    .Button = msoButtonSetOkCancel

    .Heading = "Regional Sales Data"

    .Text = "Select a region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Show

End With

Gestion de plusieurs bulles

Le Compagnon Office ne comporte pas de collection de bulles. Pour traiter plusieurs bulles, vous pouvez soit affecter chaque bulle à une variable objet à laquelle vous pourrez ensuite faire référence, soit créer un tableau de variables d'objets Balloon et affecter une bulle à chacune d'elles. L'exemple qui suit montre comment créer un tableau, puis y ajouter trois objets Balloon vides.

Dim myBalloonArray(3) As Balloon

With Assistant

    For i = 1 To 3

        Set myBalloonArray(i) = .NewBalloon

    Next

End With


Modification de bulles en cours d'exécution

Après avoir créé une bulle pour le Compagnon Office, vous pouvez la personnaliser en ajoutant au titre ou au corps de texte des images en mode point, des icônes, des métafichiers Windows ou des fichiers PICT Macintosh. Vous pouvez également ajouter des contrôles tels que des cases à cocher ou des boutons de façon à fournir des explications à l'utilisateur lorsqu'il clique sur un élément de la bulle.

Ajout d'icônes et d'images en mode point dans une bulle

Pour personnaliser votre application, vous pouvez ajouter des icônes et des images en mode point dans les bulles du Compagnon Office. Pour ajouter une icône, affectez une constante MsoIconType à la propriété Icon de l'objet Balloon. Pour ajouter une image en mode point Windows ou Macintosh, un métafichier Windows ou un fichier PICT Macintosh au texte d'une bulle du Compagnon Office, spécifiez le type, l'emplacement et, au besoin, la taille lorsque vous définissez la propriété Text du titre, du texte, de la case à cocher ou de l'étiquette. L'exemple qui suit montre comment insérer une image en mode point Windows dans le texte d'une bulle.

myBmp = "{bmp c:\windows\aquarium.bmp}"

myText1 = "This is before the picture, "

myText2 = " and this is after the picture"

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Bitmap."

    .Text = myText1 & myBmp & myText2

    .Show

End With

Ajout de contrôles dans une bulle

Deux types de contrôles peuvent être ajoutés dans une bulle : les cases à cocher et les boutons. À sa création, une bulle propose cinq cases à cocher affichables individuellement par affectation d'un texte à la case. Elle propose aussi cinq boutons (s'il s'agit d'une bulle de type msoBalloonTypeButtons) rendus accessibles de la même manière que les cases à cocher. Si vous tentez d'ajouter plus de cinq cases à cocher ou plus de cinq boutons, une erreur se produit.

Vous pouvez modifier l'apparence d'un contrôle en modifiant sa propriété Text, et changer la fonction d'une case à cocher ou d'un bouton en lui associant une autre procédure à exécuter chaque fois que l'utilisateur coche la case ou clique sur le bouton.

L'exemple qui suit montre comment créer une bulle avec un titre, du texte et trois choix de régions. Un message est affiché quand l'utilisateur active des cases à cocher, puis clique sur Ok dans l'info-bulle.

With Assistant.NewBalloon

    .Heading = "Regional Sales Data"

    .Text = "Select your region"

    For i = 1 To 3

        .CheckBoxes(i).Text = "Region " & i

    Next

    .Button = msoButtonSetOkCancel

    .Show

Select Case True

    Case .CheckBoxes(1).Checked

        runregion1

    Case .CheckBoxes(2).Checked

        runregion2

    Case .CheckBoxes(3).Checked

        runregion3

End Select

End With


Les barres de commandes

Dans Microsoft Office 97, les barres d'outils, les barres de menus et les menus contextuels sont contrôlés par programmation au moyen d'un seul type d'objet : l'objet CommandBar, qui représente les barres de commandes. Dans Visual Basic, tous les objets suivants correspondent à des objets CommandBar :

•	les barres de menus, les barres d'outils et les menus contextuels ;

•	les menus des barres de menus et des barres d'outils ;

•	les sous-menus des menus, des sous-menus et des menus contextuels.

Toutes les barres de menus et d'outils intégrées sont modifiables. De plus, vous pouvez créer et modifier vos propres barres d'outils, barres de menus et menus contextuels personnalisés et les livrer avec votre application Visual Basic. Les fonctionnalités de votre application peuvent être représentées par des boutons distincts sur des barres d'outils ou par des groupes de commandes dans des menus. Les barres d'outils et les menus étant assimilés à des barres de commandes, vous pouvez utiliser les mêmes types de contrôles dans les deux cas. La barre d'outils ancrée présentée ci-dessous, par exemple, contient trois boutons.

Le menu illustré ci-dessous contient trois commandes qui correspondent aux trois boutons de l'illustration précédente, présentés sous forme d'éléments de menus.

Dans Microsoft Office 97, les barres de menus et d'outils peuvent contenir des menus. La barre d'outils flottante illustrée ci-dessous contient trois boutons et un menu qui propose trois commandes correspondant à ces boutons présentés sous forme d'éléments de menus.

Dans Visual Basic, les boutons et les éléments de menus sont représentés par des objets CommandBarButton. Les menus contextuels, qui affichent des menus et des sous-menus, sont représentés par des objets CommandBarPopup. Les menus contextuels nommés « Menu » et « Sous-menus », qui affichent respectivement un menu et un sous-menu, sont illustrés ci-dessous. Le menu et le sous-menu correspondent chacun à un objet CommandBar unique disposant de ses propres contrôles.

Dans Microsoft Office 97, vous pouvez également ajouter aux barres de commandes des zones de texte, des zones de liste déroulante et des zones de liste modifiable. Dans Visual Basic, ces trois types de contrôles sont représentés par des objets CommandBarComboBox.

Remarque   Même si leur aspect et leur mode de fonctionnement est similaire, les barres de commandes et les contrôles ActiveX présentent certaines différences. En effet, les contrôles ActiveX ne peuvent pas être ajoutés aux barres de commandes et les contrôles de barres de commandes ne peuvent pas être insérés dans des documents ou des formulaires.

Dans Visual Basic, les barres de commandes intégrées des applications conteneur sont également représentées par des objets CommandBarButton, CommandBarPopup et CommandBarComboBox, mais leur aspect et leur mode de fonctionnement est souvent plus complexe que celui des contrôles que vous ajoutez vous-même. Vous pouvez déplacer des contrôles intégrés et modifier leur aspect, mais vous ne pouvez pas changer leur mode de fonctionnement intégré. Vous pouvez toutefois leur affecter une macro personnalisée qui modifie totalement le mode de fonctionnement du contrôle.


Utilisation des barres de commandes

En général, vous devez utiliser les options de personnalisation de l'application conteneur pour créer ou modifier les barres d'outils, les barres de menus et les menus contextuels que vous voulez intégrer dans vos applications Visual Basic. Les modifications apportées aux barres d'outils, aux barres de menus et aux menus contextuels à l'aide des options de l'application conteneur sont appelées modifications « au moment de la création ». Pour plus d'informations sur l'emploi de l'application conteneur pour modifier des contrôles au moment de la création, consultez l'aide en ligne de l'application.

Pour ajouter ou modifier des barres d'outils, des barres de menus et des menus contextuels (ainsi que leurs composants) utilisez la partie CommandBars du modèle d'objet Microsoft Office conçu en code Visual Basic. Pour créer des barres d'outils et des barres de menus, vous pouvez écrire un code qui n'est exécuté qu'une fois et simule en fait le type de modifications que vous pouvez apporter au moment de la création. Certaines applications conteneur requièrent toutefois l'emploi concomitant du code Visual Basic et de l'interface de personnalisation. Les cas les plus courants dans lesquels vous devrez utiliser à la fois du code et l'interface de l'application conteneur sont les suivants :

•	Quand votre application conteneur n'offre pas d'interface pour l'ajout ou la modification de zones d'édition, de zones de liste déroulante ou de zones de liste modifiable dans les barres d'outils. Vous devez alors utiliser du code Visual Basic pour ajouter et configurer ces types de contrôles.

•	Quand votre application conteneur offre une interface pour la création de barres d'outils mais pas pour la création d'une nouvelle barre de menus. Vous devez alors faire appel à Visual Basic pour créer une barre de menus. Après avoir créé la barre de menus dans Visual Basic, vous pouvez créer les menus qu'elle contient à l'aide de l'interface de l'application conteneur.

•	Quand votre application conteneur n'offre aucun moyen d'afficher des menus contextuels personnalisés dès lors que l'interface de personnalisation est active. Vous devez donc faire appel à du code Visual Basic pour modifier ces menus contextuels.

Vous pouvez aussi écrire du code dans votre application Visual Basic ayant pour fonction d'apporter des modifications aux barres d'outils et de menus pendant l'exécution de l'application (par exemple, un code qui désactive une commande de barre de menus sous certaines conditions, ou qui ajoute des boutons dans une barre d'outils en fonction des actions de l'utilisateur). Les modifications effectuées par le biais d'un code tandis que votre application Visual Basic s'exécute sont appelées modifications « en cours d'exécution ».

Les rubriques ci-après traitent de la façon dont vous pouvez apporter des modifications « au moment de la création » et « en cours d'exécution » aux barres d'outils et de menus par le biais de code Visual Basic.

Ajout et modification de barres d'outils

Ajout et modification de barres de menus et d'éléments de menus

Ajout et affichage de menus contextuels


Ajout et modification de barres d'outils

Toutes les applications hôtes proposent une interface étendue permettant l'ajout et la configuration de barres d'outils personnalisées (avec ajout de boutons intégrés, de boutons représentant des macros ou même de zones de liste déroulante dans les barres d'outils). Les modifications effectuées « au moment de la création » par le biais de code Visual Basic portent généralement sur l'ajout ou la modification de zones de liste modifiable. En effet, l'emploi de code pour les barres d'outils est essentiellement réservé aux modifications « en cours d'exécution » (modification de l'état d'un bouton, de son aspect, de l'action qui lui est associée, etc.).

Modification de barres d'outils en cours d'exécution

Plusieurs modifications peuvent être apportées à une barre d'outils en cours d'exécution. En particulier, il est possible de modifier l'état d'un bouton de barre d'outils. Chaque bouton comporte deux états actifs : enfoncé (True) et non enfoncé (False). Pour modifier l'état d'un bouton, affectez à sa propriété State la constante appropriée, comme indiqué dans le tableau présenté plus bas dans cette rubrique.

En cours d'exécution, vous pouvez également modifier l'aspect d'un bouton ou l'action qu'iI démarre. Pour modifier l'aspect d'un bouton sans modifier son action, utilisez les propriétés CopyFace et PasteFace. Ces propriétés sont utiles lorsque vous voulez recopier sur le Presse-papiers l'image d'un bouton particulier ou l'importer dans une autre application afin d'en modifier certaines options. Pour transférer l'image d'un bouton à partir du Presse-papiers vers un bouton spécifique, utilisez la propriété PasteFace.

Pour remplacer l'action associée à un bouton par une fonction que vous avez vous-même développée, affectez le nom de votre procédure personnalisée à la propriété OnAction du bouton.

Le tableau qui suit répertorie les propriétés et méthodes généralement utilisées pour modifier l'état, l'aspect et l'action d'un bouton.

Propriété ou méthode	Description
CopyFace, PasteFace	Copie ou colle l'image d'un bouton. Pour copier dans le Presse-papiers l'image du bouton spécifié, utilisez la méthode CopyFace. Pour coller le contenu du Presse-papiers sur le bouton spécifié, utilisez la méthode PasteFace. La méthode PasteFace échoue si le Presse-papiers est vide. L'image du Presse-papiers n'est pas automatiquement réduite même si elle est plus grande que la face avant du bouton. Bien qu'il soit possible de copier ou de coller l'image d'un bouton en cours d'exécution, il est généralement plus facile d'effectuer ces opérations au moment de la création. Par ailleurs, vous pouvez utiliser la propriété FaceId pour affecter une image de bouton intégrée à un bouton.
Id	Spécifie la valeur qui correspond à la fonction intégrée du bouton. Ainsi, 19 est la valeur Id d'un bouton qui copie dans le Presse-papiers du texte mis en surbrillance.
State	Spécifie l'aspect ou l'état du bouton. Il peut s'agir de l'une des constantes suivantes : msoButtonDown, msoButtonMixed ou msoButtonUp.
Style	Spécifie si l'image du bouton affiche l'icône ou l'intitulé de ce dernier. Il peut s'agir de l'une des constantes suivantes : msoButtonAutomatic, msoButtonIcon, msoButtonCaption ou msoButtonIconandCaption.
OnAction	Spécifie la procédure à exécuter chaque fois que l'utilisateur clique sur un bouton, affiche un menu ou modifie le contenu d'une zone de liste modifiable.
Visible	Spécifie si le contrôle est affiché ou masqué.
Enabled	Active ou désactive une barre de commandes. Le nom d'une barre de commandes désactivée ne s'affiche pas dans la liste des barres de commandes disponibles.
Dans l'exemple qui suit, il est supposé que les deux premiers contrôles de la barre de commandes BoutonsPersonnalisés sont des boutons. La procédure HideThem masque le premier bouton et affecte une procédure à la propriété OnAction du deuxième bouton. Lorsque la procédure OnAction s'exécute, le premier contrôle est visible et le deuxième est masqué. Si l'utilisateur active le deuxième bouton tandis que la procédure s'exécute, elle est interrompue. Notez que les variables StartBtn et StopBtn doivent être déclarées en tant que variables globales.

Sub HideThem()

Set v = CommandBars("CustomButtons")

Set startbtn = v.Controls(1)

With startbtn

    .Visible = False

    .Caption = "Stop Processing"

End With

Set stopBtn = v.Controls(2)

stopBtn.OnAction = "onActionButtons"

End Sub

Sub onActionButtons()

stopBtn.Visible = False

With startBtn

    .Visible = True

    .Style = msoButtonCaption

End With

Do While startBtn.State <> True

'Continue processing sub

Loop

End Sub

Ajout et modification de zones de liste modifiable

Les zones d'édition, les zones de liste déroulante et les zones de liste modifiable sont de nouveaux contrôles très puissants qui peuvent être ajoutés dans les barres d'outils d'une application Visual Basic. Mais, pour créer ces contrôles, la plupart des applications conteneur requièrent l'emploi de code Visual Basic. Pour créer une zone de liste modifiable, utilisez les propriétés et méthodes décrites dans le tableau ci-dessous.

Propriété ou méthode	Description
Add	Ajoute une zone de liste modifiable dans une barre de commandes en affectant à l'argument Type l'une des constantes MsoControlType suivantes : msoControlEdit, msoControlDropdown ou msoControlComboBox.
AddItem	Ajoute un élément dans la liste d'une zone de liste déroulante ou modifiable. Vous pouvez spécifier le numéro d'index du nouvel élément dans la liste existante, mais si ce numéro est supérieur au nombre d'éléments de la liste, AddItem échoue.
Caption	Spécifie l'étiquette de la zone de liste modifiable. Il s'agit de l'étiquette qui s'affiche à côté du contrôle si vous affectez la constante msoComboLabel à la propriété Style.
Style	Spécifie si la légende du contrôle spécifié s'affiche à côté du contrôle. Il peut s'agir de l'une des deux constantes suivantes : msoComboLabel (la légende s'affiche) ou msoComboNormal (la légende ne s'affiche pas).
OnAction	Spécifie la procédure à exécuter quand l'utilisateur modifie le contenu de la zone de liste modifiable.
L'exemple suivant montre comment ajouter une zone de liste modifiable étiquetée « Quarter » dans une barre d'outils personnalisée et affecter au contrôle la macro nommée « ScrollToQuarter ».

Set newCombo = CommandBars("Custom1").Controls _

    .Add(Type:=msoControlComboBox)

With newCombo

    .AddItem "Q1"

    .AddItem "Q2"

    .AddItem "Q3"

    .AddItem "Q4"

    .Style = msoComboNormal

    .OnAction = "ScrollToQuarter"

End With

En cours d'exécution, la procédure affectée à la propriété OnAction de la zone de liste modifiable est appelée chaque fois que l'utilisateur modifie la zone. Vous pouvez utiliser dans cette procédure la propriété ActionControl de l'objet CommandBars pour déterminer quel contrôle a été modifié et renvoyer sa nouvelle valeur. La propriété ListIndex renvoie l'élément tapé ou sélectionné dans la zone de liste modifiable.


Ajout et modification de barres de menus et d'éléments de menus

Certaines applications conteneur n'offrent aucun moyen de création de nouvelles barres de menus. Vous devez alors utiliser Visual Basic. Une fois une barre de menus créée dans Visual Basic, vous pouvez la personnaliser par le biais de l'interface de l'application conteneur ou continuer d'utiliser Visual Basic.

Ajout de barres de menus en cours d'exécution

Pour ajouter une barre de menus dans une application en cours d'exécution, appliquez la méthode Add à la collection CommandBars et affectez la valeur True à l'argument MenuBar. L'exemple qui suit montre comment ajouter une barre de menus fixe. Il montre aussi comment ancrer cette barre de menus le long du bord droit de la fenêtre de l'application. La nouvelle barre de menus est activée chaque fois que l'utilisateur appuie sur la touche ALT.

Set menubar = CommandBars.Add _

    (Name:="mBar", Position:=msoBarRight, MenuBar:=True)

With menubar

    .Protection = msoBarNoMove

    .Visible = True

End With

Modification de barres de menus en cours d'exécution

En cours d'exécution, vous pouvez modifier aussi bien la barre de menus que les contrôles qu'elle propose. Les modifications apportées à une barre de menus peuvent affecter son aspect ou sa position ; les modifications admises pour les contrôles dépendent du type du contrôle. Le tableau qui suit répertorie les propriétés et méthodes généralement utilisées pour modifier des barres de menus en cours d'exécution.

Propriété ou méthode	Description
Add	Ajoute une barre de menus en appliquant la méthode Add à la collection CommandBars et en affectant la valeur True à l'argument MenuBar.
Enabled	Si cette propriété a la valeur True, l'utilisateur peut afficher la barre de menus spécifiée à l'aide d'un code Visual Basic. Si elle a la valeur False, l'utilisateur ne peut pas afficher la barre de menus, mais elle figure dans la liste des barres de commandes disponibles.
Protection	Permet de protéger la barre de menus de certaines actions utilisateur. Il peut s'agir de l'une ou de plusieurs des constantes suivantes : msoBarNoChangeDock, msoBarNoChangeVisible, msoBarNoCustomize, msoBarNoCustomize, msoBarNoHorizontalDock, msoBarNoMove, msoBarNoProtection, msoBarNoResize et msoBarNoVerticalDock.
Position	Spécifie la position de la nouvelle barre de menus par rapport à la fenêtre de l'application. Il peut s'agir de l'une des contantes suivantes : msoBarLeft, msoBarTop, msoBarRight, msoBarBottom, msoBarFloating, msoBarPopup (utilisée pour créer des menus contextuels) ou msoBarMenuBar (pour une barre de menus Macintosh).
Visible	Spécifie si le contrôle est visible ou masqué. S'il est masqué, son nom reste tout de même affiché dans la liste des barres de commandes disponibles.
L'exemple qui suit montre comment masquer la barre de menus active et la remplacer par une barre temporaire ancrée le long du bord droit de la fenêtre de l'application et protégée contre certaines actions de l'utilisateur.

Set oldMbar = CommandBars.ActiveMenuBar

Set newMbar = CommandBars.Add _

(Name:="newMenubar", Position:=msoBarRight, _

MenuBar:=True, temporary:=True)

With newMbar

    .Visible = True

    .Protection = msoBarNoMove

End With

Fusion de barres de menus en cours d'exécution

Si votre application est destinée à être utilisée en tant que complément et qu'elle comporte des barres de menus personnalisées, il vous faudra probablement spécifier comment elles se présenteront dans l'application conteneur. Pour spécifier le mode de fusion des barres de menus, utilisez la propriété OLEMenuGroup du contrôle CommandBarPopup.

Si l'application conteneur ou le serveur ne prennent pas en charge les barres de commandes, la fusion est de type « non-Office » : la barre de menus ainsi que toutes les barres d'outils du serveur fusionnent, mais aucune barre d'outils de l'application conteneur ne fusionne. Pour spécifier le mode de fusion des barres de menus, vous pouvez également utiliser la propriété OLEUsage.

Si l'application conteneur et le serveur prennent tous deux en charge les barres de commandes, la fusion est de type « Office-dans-Office » : les contrôles de la barre de commandes sont incorporés un à un dans l'application Office. Les menus étant traités en fonction de la catégorie de groupe de menus à laquelle ils appartiennent, les propriétés OLEMenuGroup et OLEUsage ne s'appliquent qu'aux contrôles contextuels faisant partie de barre de menus.

Modification d'éléments de menus en cours d'exécution

Les modifications pouvant être apportées à un élément de menu dépendent du type de contrôle auquel cet élément appartient. Les boutons sont surtout activés ou masqués ; les zones d'édition, les zones de liste déroulante et les zones de liste modifiable offrent des possibilités plus variées, car vous pouvez y ajouter des éléments ou en supprimer, et vous pouvez en outre déterminer l'action effectuée à partir de la valeur sélectionnée. Vous pouvez remplacer l'action d'un contrôle par une fonction intégrée ou par une fonction personnalisée.

Le tableau qui suit répertorie les propriétés et méthodes généralement utilisées pour modifier l'état, l'action ou le contenu d'un contrôle.

Propriété ou méthode	Description
Add	Ajoute un élément de menu dans une barre de commandes. Dans le cas d'un contrôle intégré, vous pouvez affecter à l'argument Type l'une des constantes MsoControlType suivantes : msoControlButton, msoControlEdit, msoControlDropdown ou msoControlComboBox.
AddItem	Ajoute un élément dans la liste d'une zone de liste déroulante ou modifiable. Vous pouvez spécifier le numéro d'index du nouvel élément dans la liste existante, mais si ce numéro est supérieur au nombre d'éléments de la liste, AddItem échoue.
Style	Spécifie si l'image du bouton affiche l'icône ou la légende de ce dernier. Il peut s'agir de l'une des constantes suivantes : msoButtonAutomatic, msoButtonIcon, msoButtonCaption ou msoButtonIconandCaption.
OnAction	Spécifie la procédure à exécuter chaque fois que l'utilisateur modifie la valeur du contrôle spécifié.
Visible	Spécifie si le contrôle est visible ou masqué.
L'exemple suivant montre comment ajouter un contrôle contextuel temporaire nommé « Custom » à l'extrémité de la barre de menus active, puis ajouter à ce contrôle un bouton nommé « Import ».

Set myMenuBar = CommandBars.ActiveMenuBar

Set newMenu = myMenuBar.Controls.Add(Type:=msoControlPopup, Temporary:=True)

newMenu.Caption = "Custom"

Set ctrl1 =newMenu.Controls.Add(Type:=msoControlButton, Id:=1)

ctrl1.Caption = "Import"

ctrl1.TooltipText = "Import"

ctrl1.Style = msoButtonCaption


Ajout et affichage de menus contextuels

Un menu contextuel est une barre de commandes flottante que l'utilisateur affiche en cliquant avec le bouton droit de la souris. Ce type de menu accepte les mêmes contrôles qu'une barre de commandes, avec un même fonctionnement. La plupart des applications n'offrant pas une interface permettant la création ou la modification de menus contextuels, vous devez créer et modifier ce type de menu en cours d'exécution.

Ajout de menus contextuels en cours d'exécution

La seule différence entre les menus contextuels et les autres barres d'outils est que si vous créez un menu contextuel au moyen de la méthode Add, vous devez affecter la constante msoBarPopUp à l'argument Position. L'exemple qui suit montre comment créer un nouveau menu contextuel, y ajouter deux contrôles (avec intitulés de légende), puis afficher le nouveau menu à l'aide de la méthode ShowPopup.

Set x = CommandBars.Add("Custom", msoBarPopup)

Set y = x.Controls.Add

With y

    .FaceId = 26

    .Caption = "Analyze the data"

End With

Set z = x.Controls.Add

With z

    .FaceId = 17

    .Caption = "Graph the data"

End With

x.ShowPopup 200, 200

Affichage de menus contextuels

Pour afficher un menu contextuel, utilisez la méthode ShowPopup, comme indiqué dans l'exemple précédent.

Si l'application conteneur prend en charge l'affectation de procédures événementielles aux actions utilisateur, vous pouvez associer l'affichage d'un menu contextuel à l'activation du bouton droit de la souris. Toutes les applications ne prenant pas en charge les procédures événementielles, consultez la documentation de l'application pour savoir si elle offre cette possibilité.

Modification de menus contextuels en cours d'exécution

Les menus contextuels ne peuvent être modifiés qu'en cours d'exécution, et les modifications autorisées ne portent généralement que sur l'aspect ou sur l'action des contrôles du menu. Pour plus d'informations sur l'ajout et la modification d'éléments de menus, consultez Ajout et modification de barres de menus et d'éléments de menus.


Objets Microsoft Office


Renvoi d'un objet à partir d'une collection

La propriété Item sert à renvoyer un objet donné à partir d'une collection. L'exemple qui suit montre comment affecter à la variable cmdbar l'objet CommandBar correspondant à la première barre de commandes de la collection.

Set cmdbar = CommandBars.Item(1)

La propriété Item étant la propriété par défaut de la plupart des collections, vous pouvez omettre le mot clé Item dans ce type d'instruction.

Set cmdbar = CommandBars(1)

Pour plus d'informations sur une collection spécifique, consultez la rubrique d'aide relative à la collection ou à la propriété Item de la collection.


Rubrique d'aide non disponible

La rubrique d'aide ne peut pas être affichée car l'aide de Visual Basic Édition Applications est introuvable ou n'a pas été installée.

Pour installer l'aide de Visual Basic Édition Applications

1.	Exécutez le programme d'installation de Microsoft Office 97, puis cliquez sur Ajouter/Enlever.

2.	Cliquez sur Microsoft Access, Microsoft Excel, Microsoft PowerPoint ou Microsoft Word, puis sur Modifier.

3.	Cliquez sur Aide, puis sur Modifier.

4.	Vérifiez que la case à cocher Aide de Visual Basic ou Manuel de référence du langage (Microsoft Access) est activée.

5.	Poursuivez l'installation.


ActivateWizard, méthode

Reprend ou suspend une session du Compagnon Office.

Note   Cette méthode fait partie du processus amorcé avec la méthode StartWizard.

Syntaxe

expression.ActivateWizard(WizardID, Act, Animation)

expression   Obligatoire. Expression qui renvoie un objet Assistant.

WizardID Argument de type Long obligatoire. Nombre qui identifie de façon unique la session du Compagnon Office, telle que renvoyée par la méthode StartWizard.

Act Argument de type Variant obligatoire. Spécifie le type de modification opéré sur la session du Compagnon Office. Il peut s'agir de l'une des constantes msoWizardActTypes suivantes : msoWizardActActive, msoWizardActInactive, msoWizardActResume ou msoWizardActSuspend.

Animation Argument de type Variant facultatif. Type d'animation que le Compagnon Office utilise lorsqu'il reprend ou suspend une session.


ActivateWizard, méthode - Exemple

Cet exemple montre comment suspendre la session du Compagnon Office lancée par la méthode StartWizard. La variable HelpForWiz a reçu la valeur renvoyée par la méthode StartWizard.

Assistant.ActivateWizard WizardID:= HelpForWiz, _

   Act:=msoWizardActSuspend, Animation:=msoAnimationGoodbye


Close, méthode

Ferme la bulle non modale active.

Syntaxe

expression.Close

expression   Obligatoire. Expression qui renvoie un objet Balloon.


Close, méthode - Exemple

Cet exemple montre comment afficher une bulle qui contient des instructions permettant de sélectionner une imprimante. Dès lors que l'utilisateur clique sur le bouton OK de la bulle, la procédure ProcessPrinter s'exécute et la bulle est fermée.

Sub shar()

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Instructions for Choosing a Printer."

    .Text = "Click OK when you've chosen a printer."

    .Labels(1).Text = "Choose File, Print."

    .Labels(2).Text = "Click Setup."

    .Labels(3).Text = "Select the name of the printer."

    .BalloonType = msoBalloonTypeNumbers

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Button = msoButtonSetOK

    .Show

End With

End Sub

Sub ProcessPrinter(bln As Balloon, ibtn As Long, _

 iPriv As Long)

    Assistant.Animation = msoAnimationSearching

     ' Insert printer-specific code

    bln.Close

End Sub


EndWizard, méthode

Ferme la fenêtre du Compagnon Office et supprime la variable qui identifie de façon unique la session du Compagnon.

Note   Utilisez cette méthode pour mettre fin à la procédure commencée avec la méthode StartWizard.

Syntaxe

expression.EndWizard(WizardID, varfSuccess, Animation)

expression    Obligatoire. Expression qui renvoie un objet Assistant.

WizardID Argument de type Long obligatoire. Nombre qui identifie de façon unique une session du Compagnon Office, telle que renvoyée par la méthode StartWizard.

varfSuccess Argument de type Boolean obligatoire. Lorsque la méthode renvoie une valeur, cet argument a la valeur True si l'utilisateur a terminé la session du Compagnon avec succès.

Animation Argument de type Variant facultatif. Type d'animation que le Compagnon Office exécute en fin de session.


EndWizard, méthode - Exemple

Cet exemple montre comment fermer le Compagnon Office quand l'utilisateur a terminé avec succès une session du Compagnon. La valeur renvoyée par la méthode StartWizard est ensuite affectée à la variable HelpForWiz.

Assistant.EndWizard WizardId:=HelpForWiz, _

    varfSuccess:=True, Animation:=msoAnimationGoodbye


StartWizard, méthode

Démarre le Compagnon Office dans le cadre de l'affichage d'explications complémentaires relatives aux panneaux personnalisés du Compagnon. Renvoie un nombre qui identifie de façon unique la session du Compagnon Office.

Syntaxe

expression.StartWizard(On, Callback, PrivateX, Animation, CustomTeaser, Top, Left, Bottom, Right)

expression    Obligatoire. Expression qui renvoie un objet Assistant.

On    Argument de type Boolean obligatoire. État local du Compagnon. Lorsque la méthode renvoie une valeur, cet argument a la valeur True si l'utilisateur demande de l'aide sur le Compagnon à partir de la bulle standard proposant l'aide.

Callback    Argument de type String obligatoire. Nom de la procédure de rappel à exécuter.

PrivateX    Argument de type Long obligatoire. Identificateur unique du panneau de la bulle du Compagnon Office qui est à l'origine de la procédure de rappel.

Animation    Argument de type Variant facultatif. Type d'animation que Compagnon Office exécute au démarrage. La valeur par défaut est msoAnimationGetWizardy.

CustomTeaser    Argument de type Variant facultatif. Cet argument a la valeur True lorsque la bulle standard proposant de l'aide à l'utilisateur est remplacée par une bulle personnalisée.

Top, Left, Bottom, Right    Arguments de type Variant facultatifs. Position des coins (en points, par rapport à l'écran) du panneau personnalisé que le Compagnon Office devra éviter lors de son démarrage ou de son affichage.

Remarque

Avec la méthode StartWizard, il n'est pas nécessaire d'utiliser la propriété Visible pour afficher le Compagnon Office.


StartWizard, méthode - Exemple

Cet exemple montre comment démarrer le Compagnon Office dans le cadre de l'affichage d'explications complémentaires relatives à des assistants personnalisés existants. Si l'utilisateur clique sur la sélection de la bulle proposant de l'aide, la procédure de rappel démarre. La variable HelpForWiz se voit affecter la valeur renvoyée par la méthode StartWizard.

HelpForWiz = Assistant.StartWizard(on:=True, _

    PrivateX:=23, Callback:="myCallback", _

    Animation:=msoAnimationGetAttentionMajor, _

    CustomTeaser:=False, Top:=100, Left:=200, _

    Bottom:=50, Right:=200)


AssistWithAlerts, propriété

Cette propriété a la valeur True si les messages d'alerte de l'application s'affichent dans la bulle du Compagnon Office lorsque ce dernier est visible. Type de données Boolean en lecture-écriture.

Remarques

La propriété AssistWithAlerts correspond à l'option Afficher les avertissements dans Options du compagnon sous l'onglet Options de la boîte de dialogue Compagnon Office.

Si cette propriété a la valeur False, l'application affiche les messages d'alerte dans des boîtes de dialogue sans faire intervenir le Compagnon Office.


AssistWithAlerts, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office lorsqu'un message d'alerte est généré.

With Assistant

    .AssistWithHelp = True

    .AssistWithAlerts = True

    .Animation = msoAnimationGreeting

    .Visible = True

End With


AssistWithHelp, propriété

Cette propriété a la valeur True si le Compagnon Office s'affiche lorsque l'utilisateur appuie sur la touche F1 pour obtenir de l'aide. Type de données Boolean en lecture-écriture.

Remarques

La propriété AssistWithHelp correspond à l'option Réagir à la touche  F1 située dans le groupe Options du compagnon, sous l'onglet Options de la boîte de dialogue Compagnon Office.

Si cette propriété a la valeur False, la boîte de dialogue Rubriques de l'aide s'affiche à la place du Compagnon Office.


AssistWithHelp, propriété - Exemple

Cet exemple montre comment afficher le Compagnon Office lorsque l'utilisateur appuie sur la touche F1 pour obtenir de l'aide.

With Assistant

    .AssistWithHelp = True

    .AssistWithAlerts = True

    .Animation = msoAnimationGreeting

    .Visible = True

End With


Callback, propriété

Définit le nom de la procédure utilisée lorsqu'une bulle non modale est affichée. Type de données String en lecture-écriture.

Remarque   Si vous spécifiez une macro associée à une feuille de calcul Excel, vous devez inclure la feuille de calcul dans la référence, par exemple « Sheet1.myCallback » au lieu de « My Callback ».


Callback, propriété - Exemple

Cet exemple montre comment afficher une bulle qui contient des instructions permettant de sélectionner une imprimante. Dès lors que l'utilisateur clique sur le bouton OK de la bulle, la procédure ProcessPrinter démarre et la bulle est fermée.

Sub shar()

Set bln = Assistant.NewBalloon

With bln

    .Heading = "Select a Printer."

    .Text = "Click OK when you've selected a printer."

    .Labels(1).Text = "Network Printer"

    .Labels(2).Text = "Local Printer"

    .Labels(3).Text = "Local Color Printer"

    .BalloonType = msoBalloonTypeButtons

    .Mode = msoModeModeless

    .Callback = "ProcessPrinter"

    .Button = msoButtonSetOK

    .Show

End With

End Sub

(Chaque procédure spécifiée dans la propriété Callback contient trois arguments : la bulle qui a activé la procédure, la valeur renvoyée du bouton sur lequel l'utilisateur a appuyé et un nombre entier qui identifie de façon unique la bulle qui a appelé la procédure.)

Sub ProcessPrinter(bln As Balloon, ibtn As Long, _

 iPriv As Long)

    Assistant.Animation = msoAnimationPrinting

    Select Case ibtn

    Case 1

        ' Insert printer-specific code

        bln.Close

    Case 2

        ' Insert printer-specific code

        bln.Close

    Case 3

        ' Insert printer-specific code

        bln.Close

    End Select

    End Sub


Private, propriété

Renvoie ou définit un nombre entier qui identifie de façon unique la bulle du Compagnon Office qui est à l'origine de la procédure de rappel. Type de données Long en lecture-écriture.

Remarque

Cette propriété est utile lorsque vous utilisez la même procédure de rappel en différentes circonstances.


Private, propriété - Exemple

Cet exemple montre comment identifier la bulle du Compagnon Office en affectant la valeur 129 à la propriété Private. La procédure de rappel, myCallback, est utilisée en différentes circonstances et le nombre 129 identifie la circonstance considérée.

With myBalloon

    .Heading = "Select a region"

    .Private = 129

.Callback = "myCallback"

    .Show

End With


SetAvoidRectangle, méthode

Évite que la bulle du Compagnon Office ne s'affiche dans une zone donnée de l'écran.

Syntaxe

expression.SetAvoidRectangle(Left, Top, Right, Bottom)

expression   Obligatoire. Expression qui renvoie un objet Assistant.

Left, Top, Right, Bottom Arguments de type Long obligatoires. Coordonnées (en points, par rapport à l'écran) de la zone de l'écran où la bulle du Compagnon Office ne doit pas être affichée.

Remarque

Cette propriété a pour but d'éviter que la bulle du Compagnon Office ne recouvre les boîtes de dialogue et les bulles personnalisées.


SetAvoidRectangle, méthode - Exemple

Cet exemple montre comment éviter que la bulle du Compagnon Office, représentée par la variable myBalloon, ne s'affiche dans la zone de l'écran définie par les coordonnées spécifiées (mesurées en pixels).

With myBalloon

    .SetAvoidRectangle 300, 250, 700, 500

    .Show

End With


ResetTips, méthode

Réinitialise les conseils d'application qui s'afficheront dans la bulle du Compagnon Office.

Syntaxe

expression.ResetTips

expression   Obligatoire. Expression qui renvoie un objet Assistant.

Remarque

La méthode ResetTips correspond au bouton Réinitialiser les astuces de l'onglet Options de la boîte de dialogue Compagnon Office.


ResetTips, méthode - Exemple

Cet exemple montre comment réinitialiser les conseils d'application avant de rendre visible le Compagnon Office. Une bulle de confirmation s'affiche, informant l'utilisateur que ses conseils d'application ont été réinitialisés.

With Application.Assistant

    .Visible = True

    .Animation = msoAnimationGreeting

    .ResetTips

End With


DisplayKeysInTooltips, propriété

Cette propriété a la valeur True si les touches de raccourci sont affichées dans les info-bulles de chaque contrôle de barre de commandes. Type de données Boolean en lecture-écriture.

Remarque

Pour que les touches de raccourci s'affichent dans les info-bulles, vous devez aussi affecter la valeur True à la propriété DisplayTooltips.


DisplayKeysInTooltips, propriété - Exemple

Cet exemple montre comment définir les options de toutes les barres de commandes de Microsoft Office.

With CommandBars

    .LargeButtons = True

    .DisplayTooltips = True

    .DisplayKeysInTooltips = True

    .MenuAnimationStyle = msoMenuAnimationUnfold

End With


MenuAnimationStyle, propriété

Renvoie ou définit le mode d'animation de la barre de commandes spécifiée. Il peut s'agir de l'une des constantes msoMenuAnimation suivantes : msoMenuAnimationNone, msoMenuAnimationRandom, msoMenuAnimationUnfold ou msoMenuAnimationSlide. Type de données en lecture-écriture.


MenuAnimationStyle, propriété - Exemple

Cet exemple montre comment définir les options de toutes les barres de commandes de Microsoft Office.

With CommandBars

    .LargeButtons = True

    .DisplayTooltips = True

    .DisplayKeysInTooltips = True

    .MenuAnimationStyle = msoMenuAnimationUnfold

End With


ActionControl, propriété

Renvoie l'objet CommandBarControl dont la propriété OnAction s'est vue affecter la procédure en cours. Si cette dernière n'a pas été lancée par un contrôle de barre de commandes, la propriété renvoie la valeur Nothing. Type de données en lecture seule.


ActionControl, propriété - Exemple

Cet exemple montre comment désactiver, pendant la durée d'exécution d'une suite d'instructions, le contrôle de barre de commandes qui a démarré la procédure en cours, puis comment l'activer à nouveau.

Set theCtrl = CommandBars.ActionControl

theCtrl.Enabled = False

    'insert OnAction process here

theCtrl.Enabled = True


Context, propriété

Renvoie ou définit une chaîne de caractères qui détermine où la barre de commandes spécifiée sera enregistrée. Cette chaîne de caractères est définie et interprétée par l'application. Type de données String en lecture-écriture.

Remarque

Vous ne pouvez utiliser la propriété Context que pour les barres de commandes personnalisées. Cette propriété échoue si l'application ne reconnaît pas la chaîne de contexte ou si elle ne gère pas le changement de chaîne de contexte par programmation.


Author, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit une chaîne (jusqu'à 80 caractères) qui correspond à l'auteur répertorié dans les propriétés du document à rechercher. Type de données String en lecture-écriture.


DateCreatedFrom, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la date de création du fichier à rechercher. Cette date représente la borne inférieure de la recherche. Type de données Variant en lecture-écriture.

Remarque

Pour définir une borne supérieure pour la recherche, utilisez la propriété DateCreatedTo, ou ne définissez aucune borne pour effectuer une recherche non restreinte.


DateCreatedTo, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la date de création du fichier à rechercher. Cette date représente la borne supérieure de la recherche. Type de données Variant en lecture-écriture.


DateSavedFrom, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la date de la dernière sauvegarde du fichier à rechercher. Cette date représente la borne inférieure de la recherche. Type de données Variant en lecture-écriture.

Remarque

Pour définir une borne supérieure pour la recherche, utilisez la propriété DateSavedTo, ou ne définissez aucune borne pour effectuer une recherche non restreinte.


DateSavedTo, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la date de la dernière sauvegarde du fichier à rechercher. Cette date représente la borne supérieure de la recherche. Type de données Variant en lecture-écriture.


Keywords, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit une chaîne (jusqu'à 80 caractères) qui correspond aux mots clés répertoriés dans les propriétés du document à rechercher. Type de données String en lecture-écriture.


ListBy, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la façon dont les fichiers trouvés sont affichés dans la boîte de dialogue des résultats de recherche. Il peut s'agir de l'une des constantes msoFileFindListBy suivantes : msoFileFindListByName (qui liste les fichiers par leur nom de fichier système) ou msoFileFindListByTitle (qui liste les fichiers par leur titre). Données en lecture-écriture.


Load, méthode

Disponible uniquement sous Macintosh. Charge en mémoire la requête de recherche de fichiers spécifiée.

Syntaxe

expression.Load(bstrQueryName)

expression   Obligatoire. Expression qui renvoie un objet FileFind.

bstrQueryName   Argument de type String obligatoire. Chaîne de 31 caractères au maximum qui indique le nom de la recherche sauvegardée à charger.

Remarque

Pour lancer une requête après l'avoir chargée, utilisez la méthode Execute.


MatchCase, propriété

Disponible uniquement sous Macintosh. Cette propriété a la valeur True si la recherche tient compte des majuscules et des minuscules. Type de données Boolean en lecture-écriture.


Options, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la façon dont les derniers fichiers trouvés s'affichent par rapport à une liste antérieure de fichiers. Il peut s'agir de l'une des constantes msoFileFindOptions suivantes : msoFileFindOptionsNew, msoFileFindOptionsAdd ou msoFileFindOptionsWithin. Type de données Variant en lecture-écriture.


PatternMatch, propriété

Cette propriété a la valeur True si la chaîne de recherche définie par la propriété Text peut inclure les caractères génériques * (astérisque) et ? (point d'interrogation). Disponible uniquement sous Macintosh. Type de données Boolean en lecture-écriture.

Remarques

Utilisez le point d'interrogation pour remplacer n'importe quel caractère. Par exemple, entrez gr?ve pour rechercher tous les fichiers qui contiennent au moins une fois « grave » ou « grive ».

Utilisez l'astérisque pour remplacer un nombre quelconque de caractères. Par exemple, entrez San* pour renvoyer tous les fichiers qui contiennent au moins un mot commençant par « San ».


Results, propriété

Disponible uniquement sous Macintosh. Renvoie l'objet FileFindResults. En lecture seule.


Save, méthode

Disponible uniquement sous Macintosh. Enregistre les critères de recherche spécifiés.

Syntaxe

expression.Save(bstrQueryName)

expression Obligatoire. Expression qui renvoie un objet FileFind.

bstrQueryName Argument de type String obligatoire. Chaîne (jusqu'à 31 caractères) qui indique le nom des critères de recherche à enregistrer.


SavedBy, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit une chaîne (jusqu'à 80 caractères) qui correspond au nom de l'auteur du dernier enregistrement du fichier à rechercher. Type de données String en lecture-écriture.


SearchPath, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit le dossier sur lequel portera la recherche spécifiée. Type de données String en lecture-écriture.

Remarque

Le chemin de recherche peut comporter jusqu'à 255 caractères.


SelectedFile, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit un chiffre qui correspond au fichier mis en surbrillance dans la boîte de dialogue Rechercher le fichier. Type de données Integer en lecture-écriture.

Remarque

Pour afficher la boîte de dialogue Rechercher le fichier, utilisez la méthode Show.


SortBy, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit la méthode utilisée pour trier les fichiers renvoyés par la recherche spécifiée. Il peut s'agir de l'une des constantes msoFileFindSortBy suivantes : msoFileFindSortByAuthor, msoFileFindSortByDateCreated, msoFileFindSortByDateSaved, msoFileFindSortByFileName, msoFileFindSortByLastSavedBy, msoFileFindSortBySize ou msoFileFindSortByTitle. En lecture-écriture.


SubDir, propriété

Disponible uniquement sous Macintosh. Cette propriété a la valeur True si la recherche spécifiée porte sur tous les sous-dossiers du dossier spécifié par la propriété SearchPath. Type de données Boolean en lecture-écriture.


Subject, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit une chaîne (jusqu'à 80 caractères) qui correspond au sujet répertorié dans les propriétés du fichier à rechercher. Type de données String en lecture-écriture.


Title, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit une chaîne (jusqu'à 80 caractères) qui correspond au titre de document répertorié dans les propriétés du fichier à rechercher. Type de données String en lecture-écriture.


View, propriété

Disponible uniquement sous Macintosh. Renvoie ou définit le style utilisé pour afficher dans la boîte de dialogue les fichiers trouvés. Il peut s'agir de l'une des constantes msoFileFindView suivantes : msoFileFindViewFileInfo, msoFileFindViewPreview ou msoFileFindViewSummary. Type de données Variant en lecture seule.


FileFind, objet

Représente la boîte de dialogue Rechercher le fichier.

Utilisation de l'objet FileFind

Pour renvoyer l'objet FileFind, utilisez la propriété FileFind.


FileFindResults, objet

Représente la liste des fichiers renvoyés par une recherche.

Utilisation de l'objet FileFindResults

Pour renvoyer l'objet FileFindResults, utilisez la propriété Results.

Pour renvoyer le chemin et le nom d'un fichier trouvé, utilisez FileFindResults(item), où item est le numéro d'index.

Pour démarrer la recherche et mettre la liste à jour, utilisez la méthode Execute.

Pour afficher dans une boîte de dialogue la liste des fichiers trouvés, utilisez la propriété View.


Identificateurs par programmation OLE (Contrôles ActiveX)

Les identificateurs par programmation OLE, ou ProgID (OLE Programmatic Identifiers), servent à la création d'objets Automation. Pour créer un contrôle ActiveX, utilisez l'un des identificateurs OLE répertoriés ci-dessous.

Utilisez l'identificateur	Pour créer l'objet
Forms.CheckBox.1	CheckBox
Forms.ComboBox.1	ComboBox
Forms.CommandButton.1	CommandButton
Forms.Frame.1	Frame
Forms.Image.1	Image
Forms.Label.1	Label
Forms.ListBox.1	ListBox
Forms.MultiPage.1	MultiPage
Forms.OptionButton.1	OptionButton
Forms.ScrollBar.1	ScrollBar
Forms.SpinButton.1	SpinButton
Forms.TabStrip.1	TabStrip
Forms.TextBox.1	TextBox
Forms.ToggleButton.1	ToggleButton


Type, propriété

Objet DocumentProperty : Renvoie ou définit le type de propriété du document. Il peut s'agir de l'une des constantes MsoDocProperties suivantes : msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber ou msoPropertyTypeString. Propriété en lecture seule pour les propriétés de documents intégrées et en lecture-écriture pour les propriétés de documents personnalisées.

Objet CommandBar : Renvoie le type de barre de commandes. Il peut s'agir de l'une des constantes MsoBarType suivantes : msoBarTypeNormal, msoBarTypeMenuBar ou msoBarTypePopup. Type de données Long en lecture seule.

Objet CommandBarControl : Renvoie le type du contrôle de barre de commandes. Type de données Long en lecture seule.

Il peut s'agir de l'une des constantes MsoControlType suivantes :

Constantes	Type de contrôle
msoControlButton
msoControlButtonDropdown
msoControlButtonPopup
msoControlComboBox
msoControlCustom	Réservé.
MsoControlDropdown
msoControlEdit
msoControlExpandingGrid
msoControlGauge
msoControlGenericDropdown	Réservé.
MsoControlGraphicCombo
msoControlGraphicDropdown
msoControlGraphicPopup	Réservé.
msoControlGrid
msoControlLabel	Réservé.
msoControlOCXDropDown
msoControlPopup
msoControlSplitButtonMRUPopup
msoControlSplitButtonPopup
msoControlSplitDropdown
msoControlSplitExpandingGrid	Réservé.


Type, propriété - Exemples

Cet exemple montre comment rechercher le premier contrôle dont l'étiquette a la valeur « Change this bar ». S'il s'agit d'un bouton de barre de commandes, la valeur de son étiquette est remplacée par « Changed » et une nouvelle zone de liste modifiable est ajoutée à la fin de la barre de commandes.

Set ctrl = CommandBars _

    .FindControl(Tag:="Change this bar")

If ctrl Is Nothing Then Goto notFound

If ctrl.Type = msoControlButton Then

    Set br = ctrl.Parent

br.Controls.Add Type:=msoControlComboBox

    ctrl.Tag = "Changed"

End If

Cet exemple montre comment afficher le nom, le type et la valeur d'une propriété de document. Vous devez passer à la procédure un objet DocumentProperty valide.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub


Visible, propriété

Objets CommandBar et CommandBarControl : cette propriété a la valeur True si la barre de commandes ou le contrôle de barre de commandes spécifiés sont visibles. Type de données Boolean en lecture-écriture.

Objet Assistant : cette propriété a la valeur True si le Compagnon Office est visible. Type de données Boolean en lecture-écriture.

Remarques

Par défaut, la propriété Visible des barres de commandes personnalisées nouvellement créées est False.

Vous devez affecter la valeur True à la propriété Enabled d'une barre de commandes avant d'affecter True à sa propriété Visible.


Visible, propriété - Exemples

Cet exemple montre comment parcourir la collection de barres de commandes à la recherche de la barre « Forms ». Si cette barre est trouvée, elle est rendue visible et son ancrage est protégé.

foundFlag = False

For Each cmdbar In CommandBars

    If cmdbar.Name = "Forms" Then

        cmdbar.Protection = msoBarNoChangeDock

        cmdbar.Visible = True

        foundFlag = True

    End If

Next

If Not foundFlag Then

    MsgBox "'Forms'command bar is not in the collection."

End If

Cet exemple montre comment afficher le Compagnon Office et définir une valeur pour son animation.

With Application.Assistant

    .Visible = True

    .Sounds = True

    .Animation = msoAnimationBeginSpeaking

End With


Width, propriété

Renvoie ou définit la largeur (en pixels) de la barre de commandes ou du contrôle de barre de commandes spécifiés. Type de données Long en lecture-écriture.


Width, propriété - Exemple

Cet exemple montre comment ajouter un contrôle personnalisé avant le deuxième contrôle de la barre de commandes intitulée « Custom ». La hauteur du contrôle personnalisé est ensuite fixée à la moitié de celle de la barre de commandes et sa largeur à 50 pixels.

Set myBar = CommandBars("Custom")

barheight = myBar.Height

Set myControl = myBar.Controls _

    .Add(Type:=msoControlComboBox, Before:=2, Temporary:=True)

With myControl

    .Height = barheight / 2

    .Width = 50

End With

myBar.Visible = True


Application, propriété

Renvoie un objet Application qui représente l'application dans laquelle l'objet spécifié a été créé (application conteneur). Vous pouvez utiliser cette propriété en conjonction avec un objet Automation pour renvoyer l'application conteneur. Propriété en lecture seule.


Application, propriété - Exemple

Cet exemple montre comment renvoyer l'application dans laquelle a été créée la barre de commandes intitulée « Documents ».

Set Appobj = CommandBars("Document").Application


Creator, propriété

Renvoie le code à quatre caractères correspondant à l'application dans laquelle l'objet spécifié a été créé. Disponible uniquement sur Macintosh. Type de données Long en lecture seule.


Parent, propriété

Renvoie l'objet parent de l'objet spécifié. Propriété en lecture seule.


Parent, propriété - Exemple

Cet exemple montre comment afficher le nom de l'objet parent d'une propriété de document. Vous devez passer à la procédure un objet DocumentProperty valide.

Sub DisplayParent(dp as DocumentProperty)

    MsgBox dp.Parent.Name

End Sub


ShortcutText, propriété

Renvoie ou définit le détail des touches de raccourci qui est affiché en regard du bouton spécifié lorsque ce dernier apparaît dans un menu, un sous-menu ou un menu contextuel. Type de données String en lecture-écriture.

Remarque

Il n'est possible d'affecter une valeur à cette propriété que pour les boutons de barre de commandes auxquels une macro OnAction a été rattachée.


ShortcutText, propriété - Exemple

Cet exemple montre comment ajouter un bouton de création de graphiques à la barre de commandes intitulée « Custom », puis lui affecter une macro OnAction, des touches de raccourci et une légende.

Set myControl = CommandBars("Custom").Controls _

    .Add(Type:=msoControlButton, Id:= 17)

With myControl

    .OnAction = "MySub"

    .Caption = "Graph Results"

    .Control.ShortcutText = "CTRL+MAJ+M"

End With


Height, propriété

Renvoie ou définit la hauteur, en pixels, de la barre de commandes ou du contrôle de barre de commandes spécifiés. Type de données Long en lecture-écriture.

Remarque

Une erreur se produit si vous affectez une valeur à la propriété Height alors que l'état de la barre de commandes ne permet pas son redimensionnement (si elle est ancrée ou si son redimensionnement est protégé).


Height, propriété - Exemple

Cet exemple montre comment ajouter un contrôle personnalisé avant le deuxième contrôle de la barre de commandes intitulée « Custom ». La hauteur du contrôle personnalisé est fixée à la moitié de celle de la barre de commandes et sa largeur à 50 pixels.

Set myBar = CommandBars("Custom")

barHeight = myBar.Height

Set myControl = myBar.Controls _

    .Add(Type:=msoControlComboBox, Before:=2, Temporary:=True)

With myControl

    .Height = barHeight / 2

    .Width = 50

End With

myBar.Visible = True


Id, propriété

Renvoie l'identificateur (ID) de la barre de commandes intégrée spécifiée. Type de données Long en lecture seule.

Remarque

L'ID d'un contrôle détermine l'action intégrée déclenchée par ce contrôle. La valeur de la propriété Id des contrôles personnalisés est 1.


Id, propriété - Exemples

Cet exemple montre comment remplacer l'image de bouton du premier contrôle de la barre de commandes intitulée « Custom2 » si la valeur de son ID est inférieure à 25.

Set ctrl = CommandBars("Custom2").Controls(1)

With ctrl

    If .Id < 25 Then

        .FaceId = 17

        .Tag = "Changed control"

    End If

End With

Cet exemple montre comment remplacer la légende de chaque contrôle de la barre d'outils intitulée « Standard » par la valeur en cours de sa propriété Id.

For Each ctl In CommandBars("Standard").Controls

    ctl.Caption = CStr(ctl.Id)

Next ctl


Index, propriété

Renvoie le numéro d'index dans la collection de l'objet spécifié. Type de données Long en lecture seule.

Remarque

La position du premier contrôle de barre de commandes est 1. Les séparateurs ne sont pas comptés dans la collection CommandBarControls.


Index, propriété - Exemple

Cet exemple montre comment rechercher un contrôle dont la valeur d'ID est 23 dans la barre de commandes intitulée « Custom2 ». Si un tel contrôle est trouvé et que son numéro d'index est supérieur à 5, le contrôle est placé en première position sur la barre.

Set myBar = CommandBars("Custom2")

Set ctrl1 = myBar.FindControl(Id:=23)

If ctrl1.Index > 5 Then

    ctrl1.Move before:=1

End If


Item, propriété

Renvoie un objet d'une collection ou renvoie le texte associé à un objet.

Item constitue le membre par défaut de l'objet ou de la collection. Par exemple, les instructions suivantes affectent toutes deux un objet CommandBar à cmdBar.

Set cmdBar = CommandBars.Item("Standard")

Set cmdBar = CommandBars("Standard")

Les déclarations suivantes affectent toutes deux à lblText le texte de la première étiquette de l'objet Balloon affecté à myBalloon.

lblText = myBalloon.Labels(1).Item

lblText = myBalloon.Labels(1)

Choisissez l'un des objets suivants pour afficher une description détaillée de la propriété Item de cet objet.

Assistant

BalloonCheckboxes

BalloonCheckbox

BalloonLabel

BalloonLabels

CommandBarControls

CommandBars

DocumentProperties

FileFindResults

FoundFiles

PropertyTests


Item, propriété (collections CommandBars et CommandBarControls)

Renvoie un objet CommandBar à partir d'une collection CommandBars ou un objet CommandBarControl à partir d'une collection CommandBarControls. Propriété en lecture seule.

Syntaxe

expression.Item(Index)

expression   Obligatoire. Expression qui renvoie un objet CommandBar ou CommandBarControl.

Index   Argument de type Variant obligatoire. Nom ou numéro d'index de l'objet à renvoyer. Remarquez que vous ne pouvez utiliser que les numéros d'index pour renvoyer des objets PropertyTest de la collection PropertyTests.


Item, propriété (collection BalloonCheckboxes)

Renvoie un objet BalloonCheckbox à partir d'une collection BalloonCheckboxes. Propriété en lecture seule.

Syntaxe

expression.Item(iCbx)

expression   Expression qui renvoie un objet BalloonCheckbox.

iCbx   Argument de type Long obligatoire. Numéro d'index de la case à cocher à renvoyer.


Item, propriété (collection BalloonLabels)

Renvoie un objet BalloonLabel à partir d'une collection BalloonLabels. Propriété en lecture seule.

Syntaxe

expression.Item(iLbl)

expression Expression qui renvoie un objet BalloonLabel.

iLbl Argument de type Long obligatoire. Numéro d'index de l'étiquette à renvoyer.


Item, propriété (objets Assistant, BalloonLabel et BalloonCheckbox)

Renvoie le texte associé à l'objet spécifié. Type de données String en lecture seule.

Syntaxe

expression.Item

expression   Obligatoire. Expression qui renvoie un objet Assistant, BalloonCheckbox ou BalloonLabel.


Item, propriété (collection DocumentProperties)

Renvoie un objet DocumentProperty à partir d'une collection DocumentProperties. Propriété en lecture seule.

Syntaxe

expression.Item(Index)

expression   Obligatoire. Expression qui renvoie un objet DocumentProperty.

Index   Argument de type Variant obligatoire. Nom ou numéro d'index de la propriété de document à renvoyer.


Item, propriété (collection PropertyTests)

Renvoie un objet PropertyTest à partir d'une collection PropertyTests. Propriété en lecture seule.

Syntaxe

expression.Item(Index)

expression   Obligatoire. Expression qui renvoie un objet PropertyTest.

Index   Argument de type Variant obligatoire. Numéro d'index du test de propriété à renvoyer.


Item, propriété (objets FoundFiles et FileFindResults)

Renvoie un nom de fichier de la liste de noms de fichiers représentée par l'objet FoundFiles ou FileFindResults. Type de données String en lecture seule.

Syntaxe

expression.Item(Index)

expression   Obligatoire. Expression qui renvoie un objet FoundFiles ou FileFindResults (FileFindResults n'est disponible que sur Macintosh).

Index   Argument de type Variant obligatoire. Numéro d'index du nom de fichier à renvoyer.


Left, propriété

Objet CommandBar ou CommandBarControl : Renvoie ou définit la distance (en pixels) entre le bord gauche de la barre de commandes ou du contrôle de barre de commandes spécifiés et le bord gauche de l'écran. Il s'agit de la distance à compter du bord gauche de la zone d'ancrage. Type de données Long en lecture-écriture pour CommandBar et Long en lecture seule pour CommandBarControl.

Objet Assistant : Définit ou renvoie la position horizontale (en points) de la fenêtre du Compagnon Office par rapport à l'écran. Type de données Long en lecture-écriture.


Left, propriété - Exemples

Cet exemple montre comment positionner la barre de commandes personnalisée intitulée « Custom » à une distance de 110 pixels vers la gauche par rapport à sa position par défaut. L'exemple montre également comment ancrer la barre en première position en affectant la valeur 1 à son numéro d'index de rangée.

Set myBar = CommandBars("Custom")

With myBar

    .RowIndex = 1

    .Left = 140

End With

Cet exemple montre comment afficher et positionner le Compagnon Office.

With Assistant

    .Visible = True

    .Left = 300

    .Top = 300

End With


Move, méthode

Objet CommandBarControl : Déplace le contrôle de barre de commandes spécifié vers une barre de commandes existante.

Objet Assistant : Positionne le Compagnon Office.

Syntaxe 1

expression.Move(Bar, Before)

Syntaxe 2

expression.Move(xLeft, yTop)

expression   Syntaxe 1 : Obligatoire. Expression qui renvoie un objet CommandBarControl, CommandBarButton, CommandBarPopup ou CommandBarComboBox.

Syntaxe 2 : Obligatoire. Expression qui renvoie un objet Assistant.

Bar   Argument de type Variant facultatif. Objet CommandBar représentant la barre de commandes de destination pour le contrôle. Si vous ne spécifiez pas cet argument, le contrôle est repoussé à la fin de la barre de commandes qui le contient déjà.

Before   Argument de type Variant facultatif. Numéro représentant la position à laquelle le contrôle doit être inséré. Le contrôle est inséré avant celui qui occupait cette position. Si vous ne spécifiez pas cet argument, le contrôle est inséré dans la même barre de commandes.

xLeft   Argument de type Integer obligatoire. Position de gauche de la fenêtre du Compagnon Office, en points.

yTop   Argument de type Integer obligatoire. Position du haut de la fenêtre du Compagnon Office, en points.


Move, méthode - Exemples

Cet exemple montre comment placer la première zone de liste modifiable de la barre de commandes intitulée « Custom » avant le septième contrôle de cette barre. L'intitulé « Selection box » est affecté à son étiquette et une valeur faible est affectée à son numéro de priorité de façon qu'il soit probablement escamoté de la barre de commandes si tous les contrôles ne tiennent pas sur une rangée.

Set allcontrols = CommandBars("Custom").Controls

For Each ctrl In allControls

    If ctrl.Type = msoControlComboBox Then

        With ctrl

            .Move Before:=7

        	   .Tag = " Selection box"

        	   .Priority = 5

         End With

         Exit For

    End If

Next

Cet exemple montre comment afficher le Compagnon Office à une position donnée et affecter une valeur à plusieurs options avant de le rendre visible.

With Assistant

    .Reduced = True

    .Move xLeft:= 400, yTop:= 300

    .MoveWhenInTheWay = True

    .TipOfDay = True

    .Visible = True

    .Animation = msoAnimationGreeting

End With


Name, propriété

Renvoie ou définit le nom de l'objet spécifié. Type de données String en lecture-écriture pour l'objet CommandBar, et en lecture seule pour tous les autres.

Remarques

Le nom local d'une barre de commandes intégrée, quand elle n'est pas ancrée, s'affiche dans sa barre de titre et dans la liste des barres de commandes disponibles, quel que soit l'emplacement où cette liste est affichée dans l'application conteneur.

Dans le cas d'une barre de commandes intégrée, la propriété Name renvoie son nom en anglais (États-Unis). La propriété NameLocal permet de renvoyer son nom local.

Si vous modifiez la valeur de la propriété NameLocal d'une barre de commandes personnalisée, la valeur de Name est également modifiée, et vice versa.


Name, propriété - Exemples

Cet exemple montre comment rechercher la barre de commandes intitulée « Custom » dans la collection de barres de commandes et comment l'afficher si elle est trouvée.

foundFlag = False

For Each bar In CommandBars

    If bar.Name = "Custom" Then

        foundFlag = True

        bar.Visible = True

    End If

Next

If Not foundFlag Then

    MsgBox "'Custom' bar isn't in collection."

Else

    MsgBox "'Custom' bar is now visible."

End If

Cet exemple montre comment afficher le nom, le type et la valeur d'une propriété de document. Vous devez passer à la procédure un objet DocumentProperty valide.

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub