GrapeCity.Documents.Word.FillFormat

Class FillFormat

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents fill formatting for a content object.

public class FillFormat : FormattingBag, IFixedFormattingBag

Inheritance

object

FormattingBag

FillFormat

Implements

IFixedFormattingBag

Inherited Members

FormattingBag.KeyDelimiter

FormattingBag.KeyFormat

FormattingBag.ClearFormatting()

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)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Properties

GradientFill

Gets the gradient fill.

This property has effect only if the Type of this fill format is Gradient.

public GradientFill GradientFill { get; }

Property Value

GradientFill

ImageFill

Gets the image fill.

This property has effect only if the Type of this fill format is Image.

public ImageData ImageFill { get; }

Property Value

ImageData

IsFixed

Gets a value indicating whether the formatting is fixed in the class instance level.

If true, any formatting changes on an ancestor level of the same class will be ignored.

If false, changing a property on an ancestor level will apply to this level too.

For example, changing a property of Fill on style level will change that property only for those Runs that have IsFixed equal to false.

public bool IsFixed { get; }

Property Value

bool

PatternFill

Gets the pattern fill.

This property has effect only if the Type of this fill format is Pattern.

public PatternFill PatternFill { get; }

Property Value

PatternFill

SolidFill

Gets the solid color fill.

This property has effect only if the Type of this fill format is Solid.

public SolidColor SolidFill { get; }

Property Value

SolidColor

Type

Gets or sets the fill type.

public FillType Type { get; set; }

Property Value

FillType

Methods

ApplyGroupFill()

Sets the GrapeCity.Documents.Word.FillFormat.FillSource to GrapeCity.Documents.Word.FillSource.Group.

Note that this is set even if the shape is not in a group.

public bool ApplyGroupFill()

Returns

bool

True if this object is grouped (has a GroupShape parent), false otherwise.

Clean()

Sets all properties to their default values.

Also sets IsFixed to true if any properties of this class are defined on an ancestor level.

public void Clean()

Equals(FillFormat)

public bool Equals(FillFormat other)

Parameters

other FillFormat

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

FixInheritedValues()

Fixes all inherited values as "direct" values for this instance.

protected override void FixInheritedValues()

GetHashCode()

public override int GetHashCode()

Returns

int

Reset()

Resets all properties to their inherited values.

Also sets IsFixed to false.

public void Reset()