Bookmark.MoveStartWhile(Object, Object) Méthode

Définition

Espace de noms:

Microsoft.Office.Tools.Word

Assembly:

Microsoft.Office.Tools.Word.dll

Déplace la position de début du contrôle Bookmark jusqu'à ce qu'il trouve dans le document un des caractères spécifiés.

public int MoveStartWhile (ref object cset, ref object count);

abstract member MoveStartWhile : obj * obj -> int

Public Function MoveStartWhile (ByRef cset As Object, Optional ByRef count As Object) As Integer

Paramètres

cset

Object

Un ou plusieurs caractères. Cet argument respecte la casse.

count

Object

Nombre maximal de caractères de déplacement du contrôle Bookmark. Il peut s'agir d'un nombre ou de la constante wdForward ou wdBackward. Si Count est un nombre positif, le Bookmark contrôle est déplacé vers l’avant dans le document. Si c'est un nombre négatif, le contrôle Bookmark est déplacé vers l'arrière. La valeur par défaut est wdForward.

Retours

Int32

Déplacement de la position de début du contrôle Bookmark, exprimé en nombre de caractères. Si aucun caractère Cset n'est trouvé, le contrôle Bookmark n'est pas modifié et la méthode retourne 0 (zéro).

Exemples

L’exemple de code suivant ajoute un Bookmark contrôle avec du texte au premier paragraphe, puis déplace la plage du signet pendant qu’il peut trouver les caractères T, h, i ou s.

Cet exemple concerne une personnalisation au niveau du document.

private void BookmarkMoveStartWhile()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Bookmark bookmark1 =
        this.Controls.AddBookmark(this.Paragraphs[1].Range,
        "bookmark1");
    bookmark1.Text = "This is sample bookmark text.";

    object Count = bookmark1.Characters.Count;
    object cSet = "This";

    bookmark1.MoveStartWhile(ref cSet, ref Count);
}

Private Sub BookmarkMoveStartWhile()

    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim Bookmark1 As Microsoft.Office.Tools.Word.Bookmark = _
        Me.Controls.AddBookmark(Me.Paragraphs(1).Range, "Bookmark1")
    Bookmark1.Text = "This is sample bookmark text."

    Bookmark1.MoveStartWhile("This", Bookmark1.Characters.Count)
End Sub

Remarques

Lorsqu’un caractère dans Cset est trouvé, la position de début du Bookmark contrôle est déplacée.

Si la position de début est déplacée vers l’avant vers une position au-delà de la position de fin d’origine, la position de fin est définie sur la nouvelle position de début.

Paramètres facultatifs

Pour plus d’informations sur les paramètres facultatifs, consultez Paramètres facultatifs dans les solutions Office.