Click or drag to resize

ShapeObject Class

Represents a shape object that inherits from the Shapes.Shape class.
Inheritance Hierarchy

Namespace: Spire.Doc.Fields
Assembly: Spire.Doc (in Spire.Doc.dll) Version: 13.2.3.0 (13.2.3.3046)
Syntax
Copy 
public class ShapeObject : Shape

The ShapeObject type exposes the following members.

Constructors
Name Description
Public method ShapeObject(IDocument)
Ctor. Use this internally only.
Public method ShapeObject(IDocument, ShapeType)
Creates a new shape object.
Top
Properties
Name Description
Public property AllowOverlap
Gets or sets the boolean avalue. Specifies whether this shape can overlap other shapes.
(Inherited from ShapeBase .)
Public property AlternativeText
Gets or sets the alternative text.
(Inherited from ShapeBase .)
Public property AspectRatioLocked
Gets or sets the boolean valut. Specifies that the generating application should not allow aspect ratio changes for the corresponding graphic frame.
(Inherited from ShapeBase .)
Public property BehindText
Gets or sets the boolean a valut. Specifies whether the shape is below or above text.
(Inherited from ShapeBase .)
Public property Bottom
Gets the position of the bottom edge of the containing block of the shape.
(Inherited from ShapeBase .)
Public property CharacterFormat
Gets the character format.
(Inherited from ParagraphBase .)
Public property Chart
Returns a chart object. If there is a chart associated with this shape, it allows for the manipulation of chart.
Public property Charts
Returns a chart collection for the combo charts.
(Inherited from Shape .)
Public property ChildObjects
Gets the child objects of the entity.
(Overrides ShapeBase ChildObjects .)
Public property CoordOrigin
Gets or sets the origin coordinates of the point.
(Inherited from ShapeBase .)
Public property CoordSize
Gets or sets the size of the coordinate.
(Inherited from ShapeBase .)
Public property DeleteRevision
Gets the delete revision for this objects. Note this can be null. If null does not have delete revision.
(Inherited from ParagraphBase .)
Public property DistanceBottom
Gets or sets the distance between the document text and the bottom edge of the shape.
(Inherited from ShapeBase .)
Public property DistanceLeft
Gets or sets the distance between the document text and the left edge of the shape.
(Inherited from ShapeBase .)
Public property DistanceRight
Gets or sets the distance between the document text and the right edge of the shape.
(Inherited from ShapeBase .)
Public property DistanceTop
Gets or sets the distance between the document text and the top edge of the shape.
(Inherited from ShapeBase .)
Public property Document
Gets the document.
(Inherited from OwnerHolder .)
Public property DocumentObjectType
Gets the type of the document object.
(Overrides Shape DocumentObjectType .)
Public property ExtrusionEnabled
Gets or sets a value indicating whether the extrusion feature is enabled.
Public property FillColor
Defines the brush color that fills the closed path of the shape.
Public property FillTransparency
Set the fill transparency of the shape.
Public property FirstChild
Gets the first child of the Element.
(Inherited from DocumentObject .)
Public property FirstParagraph
Gets the first paragraph in the document.
(Inherited from Shape .)
Public property HasChart
Returns true if this shape has achart.
(Inherited from Shape .)
Public property HasHyperlink
Determines whether the current shape contains hyperlink.
(Inherited from ShapeBase .)
Public property HasImage
Returns true if the shape has image bytes or links an image.
(Inherited from Shape .)
Public property Height
Gets or sets the height of the containing block of the shape.
(Inherited from ShapeBase .)
Public property HorizontalAlignment
Specifies how the shape is positioned horizontally.
(Inherited from ShapeBase .)
Public property HorizontalOrigin
Specifies relative to what the shape is positioned horizontally.
(Inherited from ShapeBase .)
Public property HorizontalPosition
Gets or sets the horizontal position of the object.
(Inherited from ShapeBase .)
Public property HRef
Gets or sets the hyperlink address of the shape.
(Inherited from ShapeBase .)
Public property InsertRevision
Gets the insert revision for this objects. Note this can be null. If null does not have insert revision.
(Inherited from ParagraphBase .)
Public property IsComposite
Indicating whether this instance is composite.
(Inherited from DocumentObject .)
Public property IsDeleteRevision
Gets or set a value indicating whether this item was deleted from the document, when "Track Changes" is or was set to "true".
(Inherited from ParagraphBase .)
Public property IsInsertRevision
Gets a value indicating whether this item was inserted to the document, when "Track Changes" is or was set to "true".
(Inherited from ParagraphBase .)
Public property IsSignatureLine (Inherited from ShapeBase .)
Public property LastChild
Gets the last child of the Element.
(Inherited from DocumentObject .)
Public property LastParagraph
Gets the last paragraph in the document.
(Inherited from Shape .)
Public property LineDashing
Defines the line dashing of the stroke.
Public property LineStyle
Defines the line style of the stroke.
Public property NextSibling
Gets the next sibling.
(Inherited from DocumentObject .)
Public property Owner
Gets the owner of this entity.
(Inherited from DocumentObject .)
Public property OwnerParagraph
Gets owner paragraph.
(Inherited from ParagraphBase .)
Public property PreviousSibling
Gets the previous sibling.
(Inherited from DocumentObject .)
Public property Right
Gets the position of the right edge of the containing block of the shape.
(Inherited from ShapeBase .)
Public property Rotation
Gets or sets the rotation angle in degrees.
(Inherited from ShapeBase .)
Public property ShadowEnabled
Gets or sets a value indicating whether the shadow effect is enabled.
Public property ShapeType
Gets the shape type.
(Inherited from ShapeBase .)
Public property Size
Gets the size of the shape in its native units. Top level shapes are in points. Child shapes are in parent coordinate system.
(Inherited from ShapeBase .)
Public property StrokeColor
Defines the color of a stroke.
Public property StrokeWeight
Defines the brush thickness that strokes the path of a shape in points.
Public property StyleName
Gets the style name.
(Inherited from ParagraphBase .)
Public property TextWrappingStyle
Gets or sets the text wrapping style.
(Inherited from ShapeBase .)
Public property TextWrappingType
Specifies how the text is wrapped around the shape.
(Inherited from ShapeBase .)
Public property VerticalAlignment
Specifies how the shape is positioned vertically.
(Inherited from ShapeBase .)
Public property VerticalOrigin
Specifies relative to what the shape is positioned vertically.
(Inherited from ShapeBase .)
Public property VerticalPosition
Gets or sets the vertical position of the object.
(Inherited from ShapeBase .)
Public property Width
Gets or sets the width of the containing block of the shape.
(Inherited from ShapeBase .)
Public property WordArt
Defines the text of the text path (of a WordArt object).
Public property WrapType
Gets or sets the style of text wrapping used in the text container.
(Inherited from ShapeBase .)
Protected property XDLSHolder (Inherited from DocumentSerializable .)
Public property ZOrder
Determines the display order of overlapping shapes.
(Inherited from ShapeBase .)
Top
Methods
Name Description
Public method AdjustWithEffects
Adds to the source rectangle value of the effect extent.
(Inherited from ShapeBase .)
Public method ApplyCharacterFormat
Applies the specified character format to the current object.
(Inherited from ParagraphBase .)
Public method ApplyStyle
Applies the specified character style to the current object. If the specified style does not exist and the style name is "default paragraph font", a new built-in style is created and added to the document. If the specified style still cannot be found, an ArgumentException is thrown.
(Inherited from ParagraphBase .)
Public method Clone
Creates a duplicate of the document object.
(Inherited from DocumentObject .)
Protected method CloneImpl (Overrides ShapeBase CloneImpl .)
Protected method CreateLayoutInfo (Overrides ShapeBase CreateLayoutInfo .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetNextWidgetSibling
Gets the next widget sibling.
(Inherited from ParagraphBase .)
Public method GetPreviousWidgetSibling
Gets the previous widget sibling.
(Inherited from ParagraphBase .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method InitXDLSHolder (Overrides DocumentSerializable InitXDLSHolder .)
Public method LocalToParent
Converts a point from local coordinates to parent coordinates.
(Inherited from ShapeBase .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method ReadXmlAttributes (Overrides DocumentSerializable ReadXmlAttributes(IXDLSAttributeReader) .)
Protected method ReadXmlContent (Inherited from DocumentSerializable .)
Protected method RestoreReference (Inherited from DocumentSerializable .)
Public method SetShapeType
Sets the shape type. Users are not to modify shape type directly.
(Inherited from ShapeBase .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method ToString(String)
Exports the name and index in container of the object into a string in the specified seperator.
(Inherited from DocumentObject .)
Protected method WriteXmlAttributes (Overrides DocumentSerializable WriteXmlAttributes(IXDLSAttributeWriter) .)
Protected method WriteXmlContent (Inherited from DocumentSerializable .)
Top
Fields
Name Description
Protected field m_doc (Inherited from OwnerHolder .)
Top
See Also