GrapeCity.Documents.Word.ShapeBase

Class ShapeBase

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Base class for all types of shapes, including Shape and Picture. It also represents currently unsupported shape types such as charts etc.

Derived classes include Shape, Picture, GroupShape, CanvasShape, InkShape.

public class ShapeBase : ContentObject

Inheritance

object

ContentObject

ShapeBase

CanvasShape

GroupShape

InkShape

Picture

Shape

Inherited Members

ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AlternativeText

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.

public virtual string AlternativeText { get; set; }

Property Value

string

BlackWhiteMode

Gets 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.

public BlackWhiteMode BlackWhiteMode { get; set; }

Property Value

BlackWhiteMode

Hidden

Gets 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.

public virtual bool Hidden { get; set; }

Property Value

bool

HyperlinkOnClick

Gets the HyperlinkOnAction object specifying hyperlink properties associated with the shape when it is clicked.

public virtual HyperlinkOnAction HyperlinkOnClick { get; }

Property Value

HyperlinkOnAction

HyperlinkOnHover

Gets the HyperlinkOnAction object specifying hyperlink properties associated with the shape when the pointer hovers over it.

public virtual HyperlinkOnAction HyperlinkOnHover { get; }

Property Value

HyperlinkOnAction

ID

Gets the unique ID of the current shape in the document.

public virtual uint ID { get; }

Property Value

uint

Name

Gets or sets the current shape name.

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

public virtual string Name { get; set; }

Property Value

string

ParentRun

Gets the parent Run of the current shape.

public Run ParentRun { get; }

Property Value

Run

Position

Gets 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.

public ShapePosition Position { get; }

Property Value

ShapePosition

Rotation

Gets the ShapeRotation object that contains properties for rotating the current shape in the document.

public ShapeRotation Rotation { get; }

Property Value

ShapeRotation

Size

Gets the ShapeSize object that contains properties for sizing the current shape in the document.

public ShapeSize Size { get; }

Property Value

ShapeSize

Title

Gets or sets the title (caption) of the current shape.

public virtual string Title { get; set; }

Property Value

string

WrapFormat

Gets the WrapFormat object that contains properties for wrapping text around the current shape.

public WrapFormat WrapFormat { get; }

Property Value

WrapFormat