GrapeCity.Documents.Text.AnchoredObject

Class AnchoredObject

Namespace

GrapeCity.Documents.Text

Assembly

GcDocs.Imaging.dll

Represents an embedded object that is anchored to some text position.

public class AnchoredObject : Inline

Inheritance

object

Inline

AnchoredObject

Inherited Members

Inline.CodePointIndex

Inline.CodePointCount

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

AnchoredObject()

Creates a new instance of AnchoredObject.

public AnchoredObject()

AnchoredObject(AnchoredObject)

Creates a new instance of AnchoredObject.

public AnchoredObject(AnchoredObject source)

Parameters

source AnchoredObject

AnchoredObject(float, float, bool, HorizontalPosition, VerticalPosition, float, float)

Creates a new instance of AnchoredObject.

public AnchoredObject(float width, float height, bool wrapWithText, HorizontalPosition horizontalPosition, VerticalPosition verticalPosition, float horizontalOffset, float verticalOffset)

Parameters

width float

height float

wrapWithText bool

horizontalPosition HorizontalPosition

verticalPosition VerticalPosition

horizontalOffset float

verticalOffset float

AnchoredObject(float, float, bool, HorizontalPosition, VerticalPosition)

Creates a new instance of AnchoredObject.

public AnchoredObject(float width, float height, bool wrapWithText, HorizontalPosition horizontalPosition, VerticalPosition verticalPosition)

Parameters

width float

height float

wrapWithText bool

horizontalPosition HorizontalPosition

verticalPosition VerticalPosition

AnchoredObject(float, float, bool)

Creates a new instance of AnchoredObject.

public AnchoredObject(float width, float height, bool wrapWithText)

Parameters

width float

height float

wrapWithText bool

Properties

AttachToPreviousChar

Gets or sets a value indicating if the object should be attached to the previous visible character (True) or to the next visible character (False).

The default is false.

public bool AttachToPreviousChar { get; set; }

Property Value

bool

ContentObjectRect

Gets a rectangular area occupied by an embedded object, or 'null'.

public ObjectRect ContentObjectRect { get; }

Property Value

ObjectRect

Height

Gets or sets the height of the AnchoredObject, in graphic units.

public float Height { get; set; }

Property Value

float

HorizontalOffset

Gets or sets the horizontal offset relative to the specified position, in graphic units.

public float HorizontalOffset { get; set; }

Property Value

float

HorizontalPosition

Gets or sets the horizontal position of the AnchoredObject.

The default is CharCenter.

public HorizontalPosition HorizontalPosition { get; set; }

Property Value

HorizontalPosition

KeepInHorizontalBounds

Gets or sets a value indicating if the anchored object should not appear beyond the horizontal bounds specified by the MinLeft and MaxRight properties.

The default is false.

public bool KeepInHorizontalBounds { get; set; }

Property Value

bool

KeepInVerticalBounds

Gets or sets a value indicating if the anchored object should not appear beyond the vertical bounds specified by the MinTop and MaxBottom properties.

The default is false.

public bool KeepInVerticalBounds { get; set; }

Property Value

bool

MaxBottom

Gets or sets the maximum Bottom value of the anchored object, in graphic units.

The assigned value is ignored unless the KeepInVerticalBounds property is set to true.

public float MaxBottom { get; set; }

Property Value

float

MaxRight

Gets or sets the maximum Right value of the anchored object, in graphic units.

The assigned value is ignored unless the KeepInHorizontalBounds property is set to true.

public float MaxRight { get; set; }

Property Value

float

MinLeft

Gets or sets the minimum Left value of the anchored object, in graphic units.

The assigned value is ignored unless the KeepInHorizontalBounds property is set to true.

public float MinLeft { get; set; }

Property Value

float

MinTop

Gets or sets the minimum Top value of the anchored object, in graphic units.

The assigned value is ignored unless the KeepInVerticalBounds property is set to true.

public float MinTop { get; set; }

Property Value

float

Object

Gets or sets the embedded object referenced by the AnchoredObject.

public object Object { get; set; }

Property Value

object

ObjectRect

Gets a rectangular area which is excluded from text layout, or 'null'.

public ObjectRect ObjectRect { get; }

Property Value

ObjectRect

VerticalOffset

Gets or sets the vertical offset relative to the specified position, in graphic units.

public float VerticalOffset { get; set; }

Property Value

float

VerticalPosition

Gets or sets the vertical position of the AnchoredObject.

The default is CharCenter.

public VerticalPosition VerticalPosition { get; set; }

Property Value

VerticalPosition

Width

Gets or sets the width of the AnchoredObject, in graphic units.

public float Width { get; set; }

Property Value

float

WrapSide

Gets or sets a value specifying how text wraps around the sides of an anchored object.

The default is Both.

public WrapSide WrapSide { get; set; }

Property Value

WrapSide

WrapWithText

Gets or sets a value indicating if the anchored object should affect text layout.

The default is false.

public bool WrapWithText { get; set; }

Property Value

bool

Methods

GetCharCount()

Gets the number of UTF-16 characters.

public override int GetCharCount()

Returns

int

GetChars()

Gets the string of UTF-16 characters.

public override string GetChars()

Returns

string