GroupShape

GroupShape class

Représente un groupe de formes dans un document.

Pour en savoir plus, visitez leComment ajouter une forme de groupe dans un document Word article documentaire.

public class GroupShape : ShapeBase

Constructeurs

NomLa description
GroupShape(DocumentBase)Crée une nouvelle forme de groupe.

Propriétés

NomLa description
AllowOverlap { get; set; }Obtient ou définit une valeur qui spécifie si cette forme peut chevaucher d’autres formes.
AlternativeText { get; set; }Définit un texte alternatif à afficher à la place d’un graphique.
AnchorLocked { get; set; }Spécifie si l’ancre de la forme est verrouillée.
AspectRatioLocked { get; set; }Spécifie si les proportions de la forme sont verrouillées.
BehindText { get; set; }Spécifie si la forme est en dessous ou au-dessus du texte.
Bottom { get; }Obtient la position du bord inférieur du bloc contenant la forme.
Bounds { get; set; }Obtient ou définit l’emplacement et la taille du bloc contenant la forme.
BoundsInPoints { get; }Obtient l’emplacement et la taille du bloc contenant la forme en points, par rapport à l’ancre de la forme la plus haute.
BoundsWithEffects { get; }Obtient l’étendue finale de cet objet de forme après l’application des effets de dessin. La valeur est mesurée en points.
CanHaveImage { get; }Retoursvrai si le type de forme permet à la forme d’avoir une image.
CoordOrigin { get; set; }Les coordonnées dans le coin supérieur gauche du bloc contenant cette forme.
CoordSize { get; set; }La largeur et la hauteur de l’espace de coordonnées à l’intérieur du bloc contenant cette forme.
Count { get; }Obtient le nombre d’enfants immédiats de ce nœud.
CustomNodeId { get; set; }Spécifie l’identifiant de nœud personnalisé.
DistanceBottom { get; set; }Renvoie ou définit la distance (en points) entre le texte du document et le bord inférieur de la forme.
DistanceLeft { get; set; }Renvoie ou définit la distance (en points) entre le texte du document et le bord gauche de la forme.
DistanceRight { get; set; }Renvoie ou définit la distance (en points) entre le texte du document et le bord droit de la forme.
DistanceTop { get; set; }Renvoie ou définit la distance (en points) entre le texte du document et le bord supérieur de la forme.
virtual Document { get; }Obtient le document auquel appartient ce nœud.
Fill { get; }Obtient le formatage de remplissage pour la forme.
FirstChild { get; }Obtient le premier enfant du nœud.
FlipOrientation { get; set; }Change l’orientation d’une forme.
Font { get; }Donne accès au formatage de la police de cet objet.
HasChildNodes { get; }Retoursvrai si ce nœud a des nœuds enfants.
Height { get; set; }Obtient ou définit la hauteur du bloc contenant la forme.
HeightRelative { get; set; }Obtient ou définit la valeur qui représente le pourcentage de la hauteur relative de la forme.
HorizontalAlignment { get; set; }Spécifie comment la forme est positionnée horizontalement.
HRef { get; set; }Obtient ou définit l’adresse complète du lien hypertexte pour une forme.
override IsComposite { get; }Retoursvrai car ce nœud peut avoir des nœuds enfants.
IsDecorative { get; set; }Obtient ou définit l’indicateur qui spécifie si la forme est décorative dans le document.
IsDeleteRevision { get; }Renvoie vrai si cet objet a été supprimé dans Microsoft Word alors que le suivi des modifications était activé.
IsGroup { get; }Retoursvrai s’il s’agit d’une forme de groupe.
IsHorizontalRule { get; }Retoursvrai si cette forme est une règle horizontale.
IsImage { get; }Retoursvrai si cette forme est une forme d’image.
IsInline { get; }Un moyen rapide de déterminer si cette forme est positionnée en ligne avec le texte.
IsInsertRevision { get; }Renvoie vrai si cet objet a été inséré dans Microsoft Word alors que le suivi des modifications était activé.
IsLayoutInCell { get; set; }Obtient ou définit un indicateur indiquant si la forme est affichée à l’intérieur ou à l’extérieur d’un tableau.
IsMoveFromRevision { get; }Retoursvrai si cet objet a été déplacé (supprimé) dans Microsoft Word alors que le suivi des modifications était activé.
IsMoveToRevision { get; }Retoursvrai si cet objet a été déplacé (inséré) dans Microsoft Word alors que le suivi des modifications était activé.
IsSignatureLine { get; }Indique que la forme est unSignatureLine .
IsTopLevel { get; }Retoursvraisi cette forme n’est pas un enfant d’une forme de groupe.
IsWordArt { get; }Retoursvrai si cette forme est un objet WordArt.
LastChild { get; }Obtient le dernier enfant du nœud.
Left { get; set; }Obtient ou définit la position du bord gauche du bloc contenant la forme.
LeftRelative { get; set; }Obtient ou définit la valeur qui représente la position relative à gauche de la forme en pourcentage.
MarkupLanguage { get; }Obtient le MarkupLanguage utilisé pour cet objet graphique.
Name { get; set; }Obtient ou définit le nom de la forme facultatif.
NextSibling { get; }Obtient le nœud suivant immédiatement ce nœud.
override NodeType { get; }RetoursGroupShape .
ParentNode { get; }Obtient le parent immédiat de ce nœud.
ParentParagraph { get; }Renvoie le paragraphe parent immédiat.
PreviousSibling { get; }Obtient le nœud précédant immédiatement ce nœud.
Range { get; }Renvoie unRange objet qui représente la partie d’un document contenue dans ce nœud.
RelativeHorizontalPosition { get; set; }Spécifie par rapport à quoi la forme est positionnée horizontalement.
RelativeHorizontalSize { get; set; }Obtient ou définit la valeur de la taille relative de la forme dans la direction horizontale.
RelativeVerticalPosition { get; set; }Spécifie par rapport à quoi la forme est positionnée verticalement.
RelativeVerticalSize { get; set; }Obtient ou définit la valeur de la taille relative de la forme dans la direction verticale.
Right { get; }Obtient la position du bord droit du bloc contenant la forme.
Rotation { get; set; }Définit l’angle (en degrés) de rotation d’une forme. La valeur positive correspond à l’angle de rotation dans le sens des aiguilles d’une montre.
ScreenTip { get; set; }Définit le texte affiché lorsque le pointeur de la souris se déplace sur la forme.
ShadowFormat { get; }Obtient le formatage de l’ombre pour la forme.
ShapeType { get; }Obtient le type de forme.
SizeInPoints { get; }Obtient la taille de la forme en points.
Target { get; set; }Obtient ou définit le cadre cible pour le lien hypertexte de forme.
Title { get; set; }Obtient ou définit le titre (légende) de l’objet de forme actuel.
Top { get; set; }Obtient ou définit la position du bord supérieur du bloc contenant la forme.
TopRelative { get; set; }Obtient ou définit la valeur qui représente la position supérieure relative de la forme en pourcentage.
VerticalAlignment { get; set; }Spécifie comment la forme est positionnée verticalement.
Width { get; set; }Obtient ou définit la largeur du bloc contenant la forme.
WidthRelative { get; set; }Obtient ou définit la valeur qui représente le pourcentage de la largeur relative de la forme.
WrapSide { get; set; }Spécifie comment le texte est enroulé autour de la forme.
WrapType { get; set; }Définit si la forme est en ligne ou flottante. Pour les formes flottantes, définit le mode d’habillage du texte autour de la forme.
ZOrder { get; set; }Détermine l’ordre d’affichage des formes qui se chevauchent.

Méthodes

NomLa description
override Accept(DocumentVisitor)Accepte un visiteur.
AdjustWithEffects(RectangleF)Ajoute au rectangle source les valeurs de l’étendue de l’effet et renvoie le rectangle final.
AppendChild(Node)Ajoute le nœud spécifié à la fin de la liste des nœuds enfants pour ce nœud.
Clone(bool)Crée un duplicata du nœud.
CreateNavigator()Crée un navigateur qui peut être utilisé pour parcourir et lire des nœuds.
FetchInheritedShapeAttr(int)Réservé à l’utilisation du système. IShapeAttrSource.
FetchShapeAttr(int)Réservé à l’utilisation du système. IShapeAttrSource.
GetAncestor(NodeType)Obtient le premier ancêtre du spécifiéNodeType .
GetAncestor(Type)Obtient le premier ancêtre du type d’objet spécifié.
GetChild(NodeType, int, bool)Renvoie un Nième nœud enfant qui correspond au type spécifié.
GetChildNodes(NodeType, bool)Renvoie une collection active de nœuds enfants qui correspondent au type spécifié.
GetDirectShapeAttr(int)Réservé à l’utilisation du système. IShapeAttrSource.
GetEnumerator()Fournit la prise en charge de chaque itération de style sur les nœuds enfants de ce nœud.
GetShapeRenderer()Crée et renvoie un objet qui peut être utilisé pour restituer cette forme en image.
override GetText()Récupère le texte de ce nœud et de tous ses enfants.
IndexOf(Node)Renvoie l’index du nœud enfant spécifié dans le tableau de nœuds enfants.
InsertAfter(NodeNode)Insère le nœud spécifié immédiatement après le nœud de référence spécifié.
InsertBefore(NodeNode)Insère le nœud spécifié immédiatement avant le nœud de référence spécifié.
LocalToParent(PointF)Convertit une valeur de l’espace de coordonnées local dans l’espace de coordonnées de la forme parent.
NextPreOrder(Node)Obtient le nœud suivant selon l’algorithme de traversée de l’arbre de pré-commande.
PrependChild(Node)Ajoute le nœud spécifié au début de la liste des nœuds enfants pour ce nœud.
PreviousPreOrder(Node)Obtient le nœud précédent selon l’algorithme de traversée d’arbre de pré-commande.
Remove()Se supprime du parent.
RemoveAllChildren()Supprime tous les nœuds enfants du nœud actuel.
RemoveChild(Node)Supprime le nœud enfant spécifié.
RemoveShapeAttr(int)Réservé à l’utilisation du système. IShapeAttrSource.
RemoveSmartTags()Supprime toutSmartTagnœuds descendants du nœud actuel.
SelectNodes(string)Sélectionne une liste de nœuds correspondant à l’expression XPath.
SelectSingleNode(string)Sélectionne le premierNode qui correspond à l’expression XPath.
SetShapeAttr(int, object)Réservé à l’utilisation du système. IShapeAttrSource.
ToString(SaveFormat)Exporte le contenu du nœud dans une chaîne au format spécifié.
ToString(SaveOptions)Exporte le contenu du nœud dans une chaîne à l’aide des options de sauvegarde spécifiées.

Remarques

UNGroupShape est un nœud composite et peut avoirShape et GroupShape nœuds comme enfants.

ChaqueGroupShape définit un nouveau système de coordonnées pour ses formes enfants. Le système de coordonnées est défini à l’aide duCoordSize et CoordOrigin propriétés.

Exemples

Montre comment créer un groupe de formes et imprimer son contenu à l’aide d’un visiteur de document.

public void GroupOfShapes()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Si vous devez créer des formes "NonPrimitive", telles que SingleCornerSnipped, TopCornersSnipped, DiagonalCornersSnipped,
    // TopCornersOneRoundedOneSnipped, SingleCornerRounded, TopCornersRounded, DiagonalCornersRounded
    // veuillez utiliser les méthodes DocumentBuilder.InsertShape.
    Shape balloon = new Shape(doc, ShapeType.Balloon)
    {
        Width = 200, 
        Height = 200,
        Stroke = { Color = Color.Red }
    };

    Shape cube = new Shape(doc, ShapeType.Cube)
    {
        Width = 100, 
        Height = 100,
        Stroke = { Color = Color.Blue }
    };

    GroupShape group = new GroupShape(doc);
    group.AppendChild(balloon);
    group.AppendChild(cube);

    Assert.True(group.IsGroup);

    builder.InsertNode(group);

    ShapeGroupPrinter printer = new ShapeGroupPrinter();
    group.Accept(printer);

    Console.WriteLine(printer.GetText());
}

/// <summary>
/// Imprime le contenu d'un groupe de formes visité sur la console.
/// </summary>
public class ShapeGroupPrinter : DocumentVisitor
{
    public ShapeGroupPrinter()
    {
        mBuilder = new StringBuilder();
    }

    public string GetText()
    {
        return mBuilder.ToString();
    }

    public override VisitorAction VisitGroupShapeStart(GroupShape groupShape)
    {
        mBuilder.AppendLine("Shape group started:");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitGroupShapeEnd(GroupShape groupShape)
    {
        mBuilder.AppendLine("End of shape group");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitShapeStart(Shape shape)
    {
        mBuilder.AppendLine("\tShape - " + shape.ShapeType + ":");
        mBuilder.AppendLine("\t\tWidth: " + shape.Width);
        mBuilder.AppendLine("\t\tHeight: " + shape.Height);
        mBuilder.AppendLine("\t\tStroke color: " + shape.Stroke.Color);
        mBuilder.AppendLine("\t\tFill color: " + shape.Fill.ForeColor);
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitShapeEnd(Shape shape)
    {
        mBuilder.AppendLine("\tEnd of shape");
        return VisitorAction.Continue;
    }

    private readonly StringBuilder mBuilder;
}

Voir également