GrapeCity.Documents.Word.WrapFormat

Class WrapFormat

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents the properties for wrapping text around a shape or shape range.

public class WrapFormat : FormattingBag

Inheritance

object

FormattingBag

WrapFormat

Inherited Members

FormattingBag.KeyDelimiter

FormattingBag.KeyFormat

FormattingBag.ClearFormatting()

FormattingBag.FixInheritedValues()

FormattingBag.GetFormattingKey(string)

FormattingBag.GetShortKey(string)

FormattingBag.GetChildKeyPart(string)

FormattingBag.ConcateKeys(string, string)

FormattingBag.ConcateKeys(string[], string)

FormattingBag.ConcateKeys(string, string[])

FormattingBag.GetFormatting<T>(string, T)

FormattingBag.GetFormatting<T>(string, T, out int, bool)

FormattingBag.GetPropertyFormatting<T>(T, string)

FormattingBag.SetFormatting(string, object, bool)

FormattingBag.UpdateVersion(int?)

FormattingBag.SetPropertyFormatting(object, string)

FormattingBag.SetFormatting<T>(string, object, T, bool)

FormattingBag.SetPropertyFormattingEx<T>(object, T, string)

FormattingBag.GetDirectFormatting<T>(string, T)

FormattingBag.TryGetDirectFormatting<T>(string, T, out T, bool)

FormattingBag.GetDirectPropertyFormatting<T>(T, string)

FormattingBag.SetDirectPropertyFormatting(object, string)

FormattingBag.SetDirectPropertyFormattingEx<T>(object, T, string)

FormattingBag.RemoveDirectFormatting(string)

FormattingBag.HasDirectFormatting(string)

FormattingBag.HasDirectPropertyFormatting(string)

FormattingBag.HasDirectFormatting(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string, string)

FormattingBag.BaseKey

FormattingBag.ParentKey

FormattingBag.RootKey

FormattingBag.SyncBaseKeys

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

BehindText

Gets or sets whether a floating shape is displayed behind the text of the document when the document is displayed. When a shape is displayed within a document, that shape can intersect with text in the document. This property determines whether the text or the object is rendered on top in case of overlapping.

public bool BehindText { get; set; }

Property Value

bool

Remarks

If property Type is not None, this value does not have any effect when displaying the object.

DistanceBottom

Gets or sets the minimum distance that is maintained between the bottom edge of a shape and any subsequent text within the document when this shape is displayed within the document's contents.

public float DistanceBottom { get; set; }

Property Value

float

Remarks

If property Type is Inline or None, then this value does not have any effect when displaying the object, but can be maintained and used if the object is subsequently changed to floating.

DistanceLeft

Gets or sets the minimum distance that is maintained between the left edge of the shape and any subsequent text within the document when this shape is displayed within the document's contents.

public float DistanceLeft { get; set; }

Property Value

float

Remarks

If property Type is Inline or None or TopBottom, this value does not have any effect when displaying the object, but can be maintained and used if the object is subsequently changed to floating.

DistanceRight

Gets or sets the minimum distance that is maintained between the right edge of the shape and any subsequent text within the document when this shape is displayed within the document's contents.

public float DistanceRight { get; set; }

Property Value

float

Remarks

If property Type is Inline or None or TopBottom, this value does not have any effect when displaying the object, but can be maintained and used if the object is subsequently changed to floating.

DistanceTop

Gets or sets the minimum distance that is maintained between the top edge of the shape and any subsequent text within the document when this shape is displayed within the document's contents.

public float DistanceTop { get; set; }

Property Value

float

Remarks

If property Type is Inline or None, this value does not have any effect when displaying the object, but can be maintained and used if the object is subsequently changed to floating.

Side

Gets or sets a value indicating whether the document text wraps on both sides of a shape, on either the left or right side only, or on the side of the shape that is farthest from the page margin.

public WrapSide Side { get; set; }

Property Value

WrapSide

Remarks

If property Type is not Inline or None or TopBottom, his value does not have any effect when displaying the object.

Type

Gets or sets the wrap type of a shape.

public WrapType Type { get; set; }

Property Value

WrapType

Remarks

For nested shapes this property value is always Inline.

WrapPolygon

Gets or sets the wrapping polygon that is used to determine the extents to which text can wrap around the shape in the document.

public List<PointF> WrapPolygon { get; set; }

Property Value

System.Collections.Generic.List<T><System.Drawing.PointF>

Remarks

If property Type is not Through or not Tight, this value does not have any effect when displaying the object.