GrapeCity.Documents.Word.TextEffects

Class TextEffects

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents a text effects formatting that can be applied to an object.

public class TextEffects : FormattingBag

Inheritance

object

FormattingBag

TextEffects

ShapeEffects

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.HasDirectFormattingWithIgnore(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string, string)

FormattingBag.BaseKey

FormattingBag.ParentKey

FormattingBag.RootKey

FormattingBag.SyncBaseKeys

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

Glow

Gets the glow effect formatting.

public Glow Glow { get; }

Property Value

Glow

Reflection

Gets the reflection effect formatting.

public Reflection Reflection { get; }

Property Value

Reflection

Shadow

Gets the shadow effect formatting.

public OuterShadow Shadow { get; }

Property Value

OuterShadow

ThreeDFormat

Gets the 3D format effect.

Note: returns null for CanvasShape and GroupShape.

public ThreeDFormat ThreeDFormat { get; }

Property Value

ThreeDFormat

ThreeDScene

Gets the 3D scene effect.

Note: returns null for CanvasShape.

public ThreeDScene ThreeDScene { get; }

Property Value

ThreeDScene

Methods

ApplyBuiltInGlow(BuiltInGlowId)

Applies a built-in glow to the object.

public void ApplyBuiltInGlow(BuiltInGlowId glowId)

Parameters

glowId BuiltInGlowId

The BuiltInGlowId to apply.

ApplyBuiltInGlowInt(BuiltInGlowId)

Applies built-in glow to the object.

protected virtual void ApplyBuiltInGlowInt(BuiltInGlowId glowId)

Parameters

glowId BuiltInGlowId

A BuiltInGlowId to apply.

ApplyBuiltInReflection(BuiltInReflectionId)

Applies a built-in reflection to the object.

public void ApplyBuiltInReflection(BuiltInReflectionId reflectionId)

Parameters

reflectionId BuiltInReflectionId

The BuiltInReflectionId to apply.

ApplyBuiltInReflectionInt(BuiltInReflectionId)

Applies built-in reflection to the object.

protected virtual void ApplyBuiltInReflectionInt(BuiltInReflectionId reflectionId)

Parameters

reflectionId BuiltInReflectionId

A BuiltInReflectionId to apply.

ApplyBuiltInShadow(BuiltInShadowId)

Applies a built-in shadow to the object.

public void ApplyBuiltInShadow(BuiltInShadowId shadowId)

Parameters

shadowId BuiltInShadowId

The BuiltInShadowId to apply.

ApplyBuiltInShadowInt(BuiltInShadowId)

Applies built-in shadow to the object.

protected virtual void ApplyBuiltInShadowInt(BuiltInShadowId shadowId)

Parameters

shadowId BuiltInShadowId

A BuiltInShadowId to apply.

Clean()

Sets all effects to default values.

public virtual void Clean()

Equals(object)

public override bool Equals(object fmt)

Parameters

fmt object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

HasDirectFormatting(string, string)

Gets whether the direct formatting contains any data for an object with specified keys.

protected override bool HasDirectFormatting(string parentKey, string baseKey)

Parameters

parentKey string

The parent key of the object.

baseKey string

The base key of the object.

Returns

bool

true if the direct formatting is applied to the object with specified keys.

Reset()

Resets all effects to inherited defaults.

public void Reset()