GrapeCity.Documents.Excel.Drawing.IFillFormat

Interface IFillFormat

Namespace

GrapeCity.Documents.Excel.Drawing

Assembly

GcDocs.Excel.dll

Represents fill formatting for a shape.

public interface IFillFormat

Properties

Color

Returns the IColorFormat object that represents the specified foreground fill or solid color.

IColorFormat Color { get; }

Property Value

IColorFormat

GradientAngle

Gets or sets the angle of the gradient fill for the specified fill format.

double GradientAngle { get; set; }

Property Value

double

GradientDegree

Returns the gradient degree of the specified one-color shaded fill as a floating-point value from 0.0 (dark) through 1.0 (light).

double GradientDegree { get; }

Property Value

double

GradientPathType

Returns or sets the path type for the gradient fill.

PathShapeType GradientPathType { get; set; }

Property Value

PathShapeType

GradientStops

Returns the end point for the gradient fill.

IGradientStops GradientStops { get; }

Property Value

IGradientStops

GradientStyle

Returns the gradient style for the specified fill.

GradientStyle GradientStyle { get; }

Property Value

GradientStyle

GradientVariant

Returns the shade variant for the specified fill as an integer value from 1 through 4.

int GradientVariant { get; }

Property Value

int

Pattern

Returns the fill pattern.

PatternType Pattern { get; }

Property Value

PatternType

PatternColor

Returns the IColorFormat object that represents the specified pattern color.

IColorFormat PatternColor { get; }

Property Value

IColorFormat

PresetGradientType

Returns the preset gradient type for the specified fill.

PresetGradientType PresetGradientType { get; }

Property Value

PresetGradientType

PresetTexture

Returns the preset texture for the specified fill.

PresetTexture PresetTexture { get; }

Property Value

PresetTexture

RotateWithObject

Gets or sets if the fill style should rotate with the object.

bool RotateWithObject { get; set; }

Property Value

bool

TextureAlignment

Gets or sets the text alignment for the specified IFillFormat.

TextureAlignment TextureAlignment { get; set; }

Property Value

TextureAlignment

TextureHorizontalScale

Gets or sets the value for horizontally scaling the text for the IFillFormat.

double TextureHorizontalScale { get; set; }

Property Value

double

TextureOffsetX

Returns or sets the offset X value for the specified fill.

double TextureOffsetX { get; set; }

Property Value

double

TextureOffsetY

Returns or sets the offset Y value for the specified fill.

double TextureOffsetY { get; set; }

Property Value

double

TextureVerticalScale

Returns the texture vertical scale for the specified fill.

double TextureVerticalScale { get; set; }

Property Value

double

Transparency

Gets or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

double Transparency { get; set; }

Property Value

double

Type

Returns the fill type.

FillType Type { get; }

Property Value

FillType

Visible

Determines whether the object is visible.

bool Visible { get; set; }

Property Value

bool

Methods

OneColorGradient(GradientStyle, int, double)

Sets the specified fill to a one-color gradient.

void OneColorGradient(GradientStyle style, int variant, double degree)

Parameters

style GradientStyle

The GradientStyle to be set.

variant int

The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.

degree double

The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).

Patterned(PatternType)

Sets the specified fill to a pattern.

void Patterned(PatternType pattern)

Parameters

pattern PatternType

The PatternType object.

PresetGradient(GradientStyle, int, PresetGradientType)

Sets the specified fill to a preset gradient.

void PresetGradient(GradientStyle style, int variant, PresetGradientType presetGradientType)

Parameters

style GradientStyle

The GradientStyle object to be set.

variant int

The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.

presetGradientType PresetGradientType

The PresetGradientType object.

PresetTextured(PresetTexture)

Sets the specified fill format to a preset texture.

void PresetTextured(PresetTexture presetTexture)

Parameters

presetTexture PresetTexture

The PresetTexture.

Solid()

Sets the specified fill to a uniform color.

void Solid()

TwoColorGradient(GradientStyle, int)

Sets the specified fill to a two-color gradient.

void TwoColorGradient(GradientStyle style, int variant)

Parameters

style GradientStyle

The GradientStyle object.

variant int

The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If GradientStyle is GradientFromCenter, the Variant argument can only be 1 or 2.

UserPicture(Stream, ImageType)

Fills the specified shape with an image.

void UserPicture(Stream stream, ImageType type)

Parameters

stream System.IO.Stream

The stream of the picture file.

type ImageType

The ImageType of the stream.

UserPicture(string)

Fills the specified shape with an image.

void UserPicture(string fileName)

Parameters

fileName string

The name of the picture file.

UserTextured(Stream, ImageType)

Fills the specified shape with small tiles of an image.

void UserTextured(Stream stream, ImageType type)

Parameters

stream System.IO.Stream

The stream of the picture file.

type ImageType

The ImageType of the stream.

UserTextured(string)

Fills the specified shape with small tiles of an image.

void UserTextured(string fileName)

Parameters

fileName string

The name of the picture file.