GrapeCity.Documents.Excel.Drawing.ILineFormat

Interface ILineFormat

Namespace

GrapeCity.Documents.Excel.Drawing

Assembly

GcDocs.Excel.dll

Represents line and arrowhead formatting.

public interface ILineFormat

Properties

BeginArrowheadLength

Gets or sets the length of the arrowhead at the beginning of the specified line.

ArrowheadLength BeginArrowheadLength { get; set; }

Property Value

ArrowheadLength

BeginArrowheadStyle

Gets or sets the style of the arrowhead at the beginning of the specified line.

ArrowheadStyle BeginArrowheadStyle { get; set; }

Property Value

ArrowheadStyle

BeginArrowheadWidth

Gets or sets the width of the arrowhead at the beginning of the specified line.

ArrowheadWidth BeginArrowheadWidth { get; set; }

Property Value

ArrowheadWidth

CapStyle

Gets or sets the cap style for the end of the line. Can be one of the LineCapStyle constants.

LineCapStyle CapStyle { get; set; }

Property Value

LineCapStyle

Color

Returns the IColorFormat object that represents the specified solid color.

IColorFormat Color { get; }

Property Value

IColorFormat

DashStyle

Gets or sets the dash style for the specified line. Can be one of the LineDashStyle constants.

LineDashStyle DashStyle { get; set; }

Property Value

LineDashStyle

EndArrowheadLength

Gets or sets the length of the arrowhead at the end of the specified line.

ArrowheadLength EndArrowheadLength { get; set; }

Property Value

ArrowheadLength

EndArrowheadStyle

Gets or sets the style of the arrowhead at the end of the specified line.

ArrowheadStyle EndArrowheadStyle { get; set; }

Property Value

ArrowheadStyle

EndArrowheadWidth

Gets or sets the width of the arrowhead at the end of the specified line.

ArrowheadWidth EndArrowheadWidth { get; set; }

Property Value

ArrowheadWidth

GradientAngle

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

double GradientAngle { get; set; }

Property Value

double

GradientDegree

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

double GradientDegree { get; }

Property Value

double

GradientStops

Returns the end point for the gradient line. This property is read-only.

IGradientStops GradientStops { get; }

Property Value

IGradientStops

GradientStyle

Returns the gradient style for the specified line.

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

InsetPen

Gets or sets whether lines are drawn inside the specified shape's boundaries.

bool InsetPen { get; set; }

Property Value

bool

JoinStyle

Gets or sets the corners style of two intersecting lines. Can be one of the LineJoinStyle constants.

LineJoinStyle JoinStyle { get; set; }

Property Value

LineJoinStyle

Pattern

Gets the line pattern.

PatternType Pattern { get; }

Property Value

PatternType

PatternColor

Returns the IColorFormat object that represents the specified color of patterns.

IColorFormat PatternColor { get; }

Property Value

IColorFormat

Style

Gets or sets the LineStyle object that represents the ILineFormat style.

LineStyle Style { get; set; }

Property Value

LineStyle

Transparency

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

double Transparency { get; set; }

Property Value

double

Type

Returns the fill type of the line.

FillType Type { get; }

Property Value

FillType

Visible

Gets or sets whether the object is visible.

bool Visible { get; set; }

Property Value

bool

Weight

Gets or sets the weight of the line.

double Weight { get; set; }

Property Value

double

Methods

OneColorGradient(GradientStyle, int, double)

Sets the specified line to a one-color gradient.

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

Parameters

style GradientStyle

Required GradientStyle. Can be one of the following GradientStyle constants:GradientDiagonalDown, GradientDiagonalUp, GradientFromCenter, GradientFromCorner, GradientFromTitle, GradientHorizontal, or GradientVertical.

variant int

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

degree double

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

Patterned(PatternType)

Sets the specified line to a pattern color.

void Patterned(PatternType pattern)

Parameters

pattern PatternType

Required PatternType.

PresetGradient(GradientStyle, int, PresetGradientType)

Sets the specified line to a preset gradient.

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

Parameters

style GradientStyle

Required GradientStyle.Can be one of the following GradientStyle constants: GradientDiagonalDown, GradientDiagonalUp, GradientFromCenter, GradientFromCorner, GradientFromTitle, GradientHorizontal, or GradientVertical.

variant int

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

presetGradientType PresetGradientType

Required PresetGradientType.

Solid()

Sets the specified line to a uniform color.

void Solid()

TwoColorGradient(GradientStyle, int)

Sets the specified line to a two-color gradient.

void TwoColorGradient(GradientStyle style, int variant)

Parameters

style GradientStyle

Required GradientStyle. Can be one of the following GradientStyle constants: GradientDiagonalDown, GradientDiagonalUp, GradientFromCenter, GradientFromCorner, GradientFromTitle, GradientHorizontal, or GradientVertical.

variant int

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