GrapeCity.Documents.Word

GrapeCity.Documents.Word.ImageEffectList

Class ImageEffectList

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Represents a list of image effects.

public class ImageEffectList : FormattingBagList<ImageEffect>, IReadOnlyList<ImageEffect>, IReadOnlyCollection<ImageEffect>, IEnumerable<ImageEffect>, IEnumerable

Inheritance: object

FormattingBag

FormattingBagList<ImageEffect>

ImageEffectList

Implements: System.Collections.Generic.IReadOnlyList<T><ImageEffect>

System.Collections.Generic.IReadOnlyCollection<T><ImageEffect>

System.Collections.Generic.IEnumerable<T><ImageEffect>

System.Collections.IEnumerable

Inherited Members: FormattingBagList<ImageEffect>.Remove(int)

FormattingBagList<ImageEffect>.RemoveAll(Predicate<ImageEffect>)

FormattingBagList<ImageEffect>.Clear()

FormattingBagList<ImageEffect>.GetEnumerator()

FormattingBagList<ImageEffect>.Insert(int)

FormattingBagList<ImageEffect>.Insert(int, Guid)

FormattingBagList<ImageEffect>.IndexOf(ImageEffect)

FormattingBagList<ImageEffect>.FixInheritedValues()

FormattingBagList<ImageEffect>.Equals(FormattingBagList<ImageEffect>)

FormattingBagList<ImageEffect>.Equals(object)

FormattingBagList<ImageEffect>.GetHashCode()

FormattingBagList<ImageEffect>.Count

FormattingBagList<ImageEffect>.this[int]

FormattingBagList<ImageEffect>.Items

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()

Methods

AddAlphaBiLevel(float)

Adds a new AlphaBiLevel effect into the list.

public AlphaBiLevel AddAlphaBiLevel(float threshold)

Parameters

threshold float: The threshold value for the alpha bi-level effect.

Returns

AlphaBiLevel: The inserted AlphaBiLevel effect.

AddAlphaCeiling()

Adds a new AlphaCeiling effect into the list.

public AlphaCeiling AddAlphaCeiling()

Returns

AlphaCeiling: The inserted AlphaCeiling effect.

AddAlphaFloor()

Adds a new AlphaFloor effect into the list.

public AlphaFloor AddAlphaFloor()

Returns

AlphaFloor: The inserted AlphaFloor effect.

AddAlphaInverse(UserColor)

Adds a new AlphaInverse effect into the list.

public AlphaInverse AddAlphaInverse(UserColor color)

Parameters

color UserColor: The user color to replace transparency.

Returns

AlphaInverse: The inserted AlphaInverse effect.

AddAlphaModulation(float)

Adds a new AlphaModulation effect into the list.

public AlphaModulation AddAlphaModulation(float amount)

Parameters

amount float: The amount to scale the alpha.

Returns

AlphaModulation: The inserted AlphaModulation effect.

AddAlphaReplace(float)

Adds a new AlphaReplace effect into the list.

public AlphaReplace AddAlphaReplace(float alpha)

Parameters

alpha float: The alpha (opacity) value.

Returns

AlphaReplace: The inserted AlphaReplace effect.

AddBiLevel(float)

Adds a new BiLevel effect into the list.

public BiLevel AddBiLevel(float threshold)

Parameters

threshold float: The luminance threshold for the Bi-Level effect.

Returns

BiLevel: The inserted BiLevel effect.

AddBlur(float)

Adds a new Blur effect into the list.

public Blur AddBlur(float radius)

Parameters

radius float: The radius of the blur.

Returns

Blur: The inserted BiLevel effect.

AddColorChange(UserColor, UserColor)

Adds a new ColorChange effect into the list.

public ColorChange AddColorChange(UserColor colorFrom, UserColor colorTo)

Parameters

colorFrom UserColor: The user color getting removed.
colorTo UserColor: The user color which replaces the colorFrom.

Returns

ColorChange: The inserted ColorChange effect.

AddColorReplacement(UserColor)

Adds a new ColorReplacement effect into the list.

public ColorReplacement AddColorReplacement(UserColor color)

Parameters

color UserColor: The replace user color.

Returns

ColorReplacement: The inserted ColorReplacement effect.

AddDuotone(UserColor, UserColor)

Adds a new Duotone effect into the list.

public Duotone AddDuotone(UserColor color1, UserColor color2)

Parameters

color1 UserColor: The first user color to combine with color2 through a linear interpolation to determine the new color for pixels.
color2 UserColor: The second user color to combine with color1 through a linear interpolation to determine the new color for pixels.

Returns

Duotone: The inserted Duotone effect.

AddFillOverlay()

Adds a new FillOverlay effect into the list.

public FillOverlay AddFillOverlay()

Returns

FillOverlay: The inserted FillOverlay effect.

AddGrayscale()

Adds a new Grayscale effect into the list.

public Grayscale AddGrayscale()

Returns

Grayscale: The inserted Grayscale effect.

AddHsl(float, float, float)

Adds a new HslEffect effect into the list.

public HslEffect AddHsl(float hue, float luminance, float saturation)

Parameters

hue float: The number of degrees by which the hue is adjusted.
luminance float: The value by which the luminance is adjusted.
saturation float: The value by which the saturation is adjusted.

Returns

HslEffect: The inserted HslEffect effect.

AddLuminance(float, float)

Adds a new Luminance effect into the list.

public Luminance AddLuminance(float brightness, float contrast)

Parameters

brightness float: The value to change the brightness.
contrast float: The value to change the contrast.

Returns

Luminance: The inserted Luminance effect.

AddTint(float, float)

Adds a new Tint effect into the list.

public Tint AddTint(float amount, float hue)

Parameters

amount float: How much the color value is shifted.
hue float: The hue towards which to tint.

Returns

Tint: The inserted Tint effect.

InsertAlphaBiLevel(int, float)

Inserts a new AlphaBiLevel effect into the list.

public AlphaBiLevel InsertAlphaBiLevel(int index, float threshold)

Parameters

index int: The effect index in the list.
threshold float: The threshold value for the alpha bi-level effect.

Returns

AlphaBiLevel: The inserted AlphaBiLevel effect.

InsertAlphaCeiling(int)

Inserts a new AlphaCeiling effect into the list.

public AlphaCeiling InsertAlphaCeiling(int index)

Parameters

index int: The effect index in the list.

Returns

AlphaCeiling: The inserted AlphaCeiling effect.

InsertAlphaFloor(int)

Inserts a new AlphaFloor effect into the list.

public AlphaFloor InsertAlphaFloor(int index)

Parameters

index int: The effect index in the list.

Returns

AlphaFloor: The inserted AlphaFloor effect.

InsertAlphaInverse(int, UserColor)

Inserts a new AlphaInverse effect into the list.

public AlphaInverse InsertAlphaInverse(int index, UserColor color)

Parameters

index int: The effect index in the list.
color UserColor: The user color to replace transparency.

Returns

AlphaInverse: The inserted AlphaInverse effect.

InsertAlphaModulation(int, float)

Inserts a new AlphaModulation effect into the list.

public AlphaModulation InsertAlphaModulation(int index, float amount)

Parameters

index int: The effect index in the list.
amount float: The amount to scale the alpha.

Returns

AlphaModulation: The inserted AlphaModulation effect.

InsertAlphaReplace(int, float)

Inserts a new AlphaReplace effect into the list.

public AlphaReplace InsertAlphaReplace(int index, float alpha)

Parameters

index int: The effect index in the list.
alpha float: The alpha (opacity) value.

Returns

AlphaReplace: The inserted AlphaReplace effect.

InsertBiLevel(int, float)

Inserts a new BiLevel effect into the list.

public BiLevel InsertBiLevel(int index, float threshold)

Parameters

index int: The effect index in the list.
threshold float: The luminance threshold for the Bi-Level effect.

Returns

BiLevel: The inserted BiLevel effect.

InsertBlur(int, float)

Inserts a new Blur effect into the list.

public Blur InsertBlur(int index, float radius)

Parameters

index int: The effect index in the list.
radius float: The radius of the blur.

Returns

Blur: The inserted BiLevel effect.

InsertColorChange(int, UserColor, UserColor)

Inserts a new ColorChange effect into the list.

public ColorChange InsertColorChange(int index, UserColor colorFrom, UserColor colorTo)

Parameters

index int: The effect index in the list.
colorFrom UserColor: The user color getting removed.
colorTo UserColor: The user color which replaces the colorFrom.

Returns

ColorChange: The inserted ColorChange effect.

InsertColorReplacement(int, UserColor)

Inserts a new ColorReplacement effect into the list.

public ColorReplacement InsertColorReplacement(int index, UserColor color)

Parameters

index int: The effect index in the list.
color UserColor: The replace user color.

Returns

ColorReplacement: The inserted ColorReplacement effect.

InsertDuotone(int, UserColor, UserColor)

Inserts a new Duotone effect into the list.

public Duotone InsertDuotone(int index, UserColor color1, UserColor color2)

Parameters

index int: The effect index in the list.
color1 UserColor: The first user color to combine with color2 through a linear interpolation to determine the new color for pixels.
color2 UserColor: The second user color to combine with color1 through a linear interpolation to determine the new color for pixels.

Returns

Duotone: The inserted Duotone effect.

InsertFillOverlay(int)

Inserts a new FillOverlay effect into the list.

public FillOverlay InsertFillOverlay(int index)

Parameters

index int: The effect index in the list.

Returns

FillOverlay: The inserted FillOverlay effect.

InsertGrayscale(int)

Inserts a new Grayscale effect into the list.

public Grayscale InsertGrayscale(int index)

Parameters

index int: The effect index in the list.

Returns

Grayscale: The inserted Grayscale effect.

InsertHsl(int, float, float, float)

Inserts a new HslEffect effect into the list.

public HslEffect InsertHsl(int index, float hue, float luminance, float saturation)

Parameters

index int: The effect index in the list.
hue float: The number of degrees by which the hue is adjusted.
luminance float: The value by which the luminance is adjusted.
saturation float: The value by which the saturation is adjusted.

Returns

HslEffect: The inserted HslEffect effect.

InsertLuminance(int, float, float)

Inserts a new Luminance effect into the list.

public Luminance InsertLuminance(int index, float brightness, float contrast)

Parameters

index int: The effect index in the list.
brightness float: The value to change the brightness.
contrast float: The value to change the contrast.

Returns

Luminance: The inserted Luminance effect.

InsertTint(int, float, float)

Inserts a new Tint effect into the list.

public Tint InsertTint(int index, float amount, float hue)

Parameters

index int: The effect index in the list.
amount float: How much the color value is shifted.
hue float: The hue towards which to tint.

Returns

Tint: The inserted Tint effect.