Document Solutions for Word
DS.Documents.Word Assembly / GrapeCity.Documents.Word Namespace / Shape Class
Properties Methods

In This Topic
    Shape Class Members
    In This Topic

    The following tables list the members exposed by Shape.

    Public Properties
     NameDescription
    Public PropertyAlternativeText Gets or sets the alternative text for the shape. This text can be used by assistive technologies or applications that do not display the actual object. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyBlackWhiteModeGets or sets how to interpret color information contained within the shape to achieve a color, black and white, or grayscale rendering of the shape.

    This property specifies only the rendering mode applied to the shape; it does not affect how the actual color information is persisted.

    (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyChildren Gets the collection of the children of this content object. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyDocumentGets the DocumentBase that contains this content object. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyEffects Gets the shape effects formatting properties.  
    Public PropertyEndGets the Marker representing the end of this content object in the parent body. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyFill Gets the fill formatting properties.  
    Public PropertyGeometryType Gets or sets the geometry type of this shape.  
    Public PropertyGuid Gets the content unique identifier. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyHiddenGets or sets a value indicating whether this shape is hidden (i.e. present in the document but not visible).

    Note that an application can have settings that allow this object to be viewed.

    (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyHyperlinkOnClickGets the HyperlinkOnAction object specifying hyperlink properties associated with the shape when it is clicked. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyHyperlinkOnHoverGets the HyperlinkOnAction object specifying hyperlink properties associated with the shape when the pointer hovers over it. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyID Gets the unique ID of the current shape in the document. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyLine Gets the line formatting properties.  
    Public PropertyLinkedTextFrame Gets the first linked text frame that participates in a text frame story.  
    Public PropertyNameGets or sets the current shape name.

    Typically, this is used to store the original file name of the shape.

    (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyNext Gets the next shape.  
    Public PropertyParentBodyGets the parent Body of this content object. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyParentContentGets the parent ContentObject of this content object. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyParentRunGets the parent Run of the current shape. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyPositionGets the ShapePosition object that contains properties for positioning the current anchored shape in the document.

    Note that if the current shape is an inline shape, this property has no effect.

    (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyPrevious Gets the previous shape.  
    Public PropertyRotationGets the ShapeRotation object that contains properties for rotating the current shape in the document. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertySizeGets the ShapeSize object that contains properties for sizing the current shape in the document. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyStartGets the Marker representing the start of this content object in the parent body. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public PropertyStyle Gets the style information for this shape.  
    Public PropertyTextFrame Gets the text content of this shape.  
    Public PropertyTitle Gets or sets the title (caption) of the current shape. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Public PropertyWrapFormatGets the ShapeBase.WrapFormat object that contains properties for wrapping text around the current shape. (Inherited from GrapeCity.Documents.Word.ShapeBase)
    Top
    Public Methods
     NameDescription
    Public MethodAddLinkedTextFrameOverloaded. Adds a linked text frame that participates in a text frame story.

    Note that some geometries do not allow text frames (see Extensions.TextFrameSupported). If GeometryType of this shape does not support text frames, an exception will be thrown.

     
    Public MethodAddTextFrameAdds a text frame to this shape.

    Note that some geometries do not allow text frames (see Extensions.TextFrameSupported). If GeometryType of this shape does not support text frames, an exception will be thrown.

     
    Public MethodApplyEffectsPreset  
    Public MethodApplyPresetOverloaded. Applies a predefined fill and outline (ShapePreset) to this shape.

    Note that ShapePresets cannot be applied to line geometries (see Extensions.IsLineGeometry). If GeometryType of this shape is a line geometry, this method will do nothing and return false. For line geometries use ApplyPreset(LineShapePreset) instead.

     
    Public MethodApplyThemedStyleOverloaded. Applies a predefined ThemedShapeStyle to this shape.

    Note that ThemedShapeStyles cannot be applied to line geometries (see Extensions.IsLineGeometry). If GeometryType of this shape is a line geometry, this method will do nothing and return false. For line geometries use ApplyThemedStyle(ThemedLineStyle) instead.

     
    Public MethodCanAddOverloaded. Checks whether a ContentObject of the specified type can be added to the current object. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public MethodCanAddContentControlOverloaded. Checks whether a ContentControl of the specified type can be added to the current object. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public MethodDeleteDeletes this content object from the parent Body.

    Note that the position occupied by this content object in the parent can still be accessed (e.g. to insert new content) via a PersistentRange if one has previously been created with GetPersistentRange.

    (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public MethodGetChildren<T> Gets the collection of this content object's children of a specified type. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public MethodGetPersistentRangeCreates and returns a PersistentRange associated with this content object.

    Unlike the Range returned by GetRange, this persistent range and any markers on it (see Start and End) can still be used if the object is deleted.

    Note that PersistentRange should be disposed when no longer needed to improve performance.

    (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public MethodGetRangeCreates and returns a Range associated with this content object.

    To get a range that can be used after the object has been deleted, see GetPersistentRange.

    (Inherited from GrapeCity.Documents.Word.ContentObject)
    Public MethodToString Gets string representation of the content. (Inherited from GrapeCity.Documents.Word.ContentObject)
    Top
    See Also

    Reference

    Shape Class
    GrapeCity.Documents.Word Namespace