LineFormat
Source: aspose.
Represents all setting of the line.
Methods
- equals(obj)
- getBeginArrowheadLength()
- getBeginArrowheadStyle()
- getBeginArrowheadWidth()
- getCapType()
- getCompoundType()
- getDashStyle()
- getEndArrowheadLength()
- getEndArrowheadStyle()
- getEndArrowheadWidth()
- getFillType()
- getGradientColor1()
- getGradientColor2()
- getGradientColorType()
- getGradientDegree()
- getGradientFill()
- getGradientStyle()
- getGradientVariant()
- getImageData()
- getJoinType()
- getPattern()
- getPatternFill()
- getPictureFormatType()
- getPresetColor()
- getScale()
- getSetType()
- getSolidFill()
- getTexture()
- getTextureFill()
- getTransparency()
- getType()
- getWeight()
- hashCode()
- setBeginArrowheadLength()
- setBeginArrowheadStyle()
- setBeginArrowheadWidth()
- setCapType()
- setCompoundType()
- setDashStyle()
- setEndArrowheadLength()
- setEndArrowheadStyle()
- setEndArrowheadWidth()
- setFillType()
- setImageData()
- setJoinType()
- setOneColorGradient(color, degree, style, variant)
- setPattern()
- setPictureFormatType()
- setPresetColorGradient(presetColor, style, variant)
- setScale()
- setSetType()
- setTexture()
- setTransparency()
- setTwoColorGradient(color1, color2, style, variant)
- setTwoColorGradient(color1, transparency1, color2, transparency2, style, variant)
- setType()
- setWeight()
Methods
equals(obj) → boolean
Determines whether this instance has the same value as another specified LineFormat object.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
obj |
Object |
|
The |
- Returns
-
booleantrue if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false.
getBeginArrowheadLength()
Gets and sets the begin arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
getBeginArrowheadStyle()
Gets and sets the begin arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
getBeginArrowheadWidth()
Gets and sets the begin arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
getCapType()
Specifies the ending caps. The value of the property is LineCapType integer constant.
getCompoundType()
Specifies the line compound type. The value of the property is MsoLineStyle integer constant.
getDashStyle()
Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.
getEndArrowheadLength()
Gets and sets the end arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
getEndArrowheadStyle()
Gets and sets the end arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
getEndArrowheadWidth()
Gets and sets the end arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
getFillType()
Gets and sets fill type The value of the property is FillType integer constant.
getGradientColor1()
Returns the gradient color 1 for the specified fill.
getGradientColor2()
Returns the gradient color 2 for the specified fill. Only when the gradient color type is GradientColorType.TwoColors, this property is meaningful.
getGradientColorType()
Returns the gradient color type for the specified fill. The value of the property is GradientColorType integer constant.
getGradientDegree()
Returns the gradient degree for the specified fill. Only applies for Excel 2007. Can only be a value from 0.0 (dark) through 1.0 (light).
getGradientFill()
Gets GradientFill object.
getGradientStyle()
Returns the gradient style for the specified fill. The value of the property is GradientStyleType integer constant.
getGradientVariant()
Returns the gradient variant for the specified fill. Only applies for Excel 2007. Can only 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 style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.
getImageData()
Gets and sets the picture image data. If the fill format is not custom texture format, returns null.
getJoinType()
Specifies the line join type. The value of the property is LineJoinType integer constant.
getPattern()
Represents an area's display pattern. The value of the property is FillPattern integer constant.
getPatternFill()
Gets PatternFill object.
getPictureFormatType()
Gets and sets the picture format type. The value of the property is FillPictureType integer constant.
getPresetColor()
Returns the gradient preset color for the specified fill. The value of the property is GradientPresetType integer constant.
getScale()
Gets and sets the picture format scale.
getSetType()
Gets the fill format set type. The value of the property is FormatSetType integer constant. NOTE: This member is now obsolete. Instead, please use FillFormat.FillType property instead. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
getSolidFill()
Gets SolidFill object.
getTexture()
Represents the texture type for the specified fill. The value of the property is TextureType integer constant.
getTextureFill()
Gets TextureFill object.
getTransparency()
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
getType()
Gets and sets the fill type. The value of the property is FillType integer constant. NOTE: This member is now obsolete. Instead, please use FillFormat.FillType property instead. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
getWeight()
Gets or sets the weight of the line in unit of points.
hashCode() → Number
Gets the hash code.
- Returns
-
Number
setBeginArrowheadLength()
Gets and sets the begin arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
setBeginArrowheadStyle()
Gets and sets the begin arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
setBeginArrowheadWidth()
Gets and sets the begin arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
setCapType()
Specifies the ending caps. The value of the property is LineCapType integer constant.
setCompoundType()
Specifies the line compound type. The value of the property is MsoLineStyle integer constant.
setDashStyle()
Specifies the line dash type. The value of the property is MsoLineDashStyle integer constant.
setEndArrowheadLength()
Gets and sets the end arrow length type of the line. The value of the property is MsoArrowheadLength integer constant.
setEndArrowheadStyle()
Gets and sets the end arrow type of the line. The value of the property is MsoArrowheadStyle integer constant.
setEndArrowheadWidth()
Gets and sets the end arrow width type of the line. The value of the property is MsoArrowheadWidth integer constant.
setFillType()
Gets and sets fill type The value of the property is FillType integer constant.
setImageData()
Gets and sets the picture image data. If the fill format is not custom texture format, returns null.
setJoinType()
Specifies the line join type. The value of the property is LineJoinType integer constant.
setOneColorGradient(color, degree, style, variant)
Sets the specified fill to a one-color gradient. Only applies for Excel 2007.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
color |
|
One gradient color. |
|
|
degree |
Number |
|
The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light). |
|
style |
Number |
|
GradientStyleType |
|
variant |
Number |
|
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 style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setPattern()
Represents an area's display pattern. The value of the property is FillPattern integer constant.
setPictureFormatType()
Gets and sets the picture format type. The value of the property is FillPictureType integer constant.
setPresetColorGradient(presetColor, style, variant)
Sets the specified fill to a preset-color gradient. Only applies for Excel 2007.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
presetColor |
Number |
|
GradientPresetType |
|
style |
Number |
|
GradientStyleType |
|
variant |
Number |
|
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 style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setScale()
Gets and sets the picture format scale.
setSetType()
Gets the fill format set type. The value of the property is FormatSetType integer constant. NOTE: This member is now obsolete. Instead, please use FillFormat.FillType property instead. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
setTexture()
Represents the texture type for the specified fill. The value of the property is TextureType integer constant.
setTransparency()
Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).
setTwoColorGradient(color1, color2, style, variant)
Sets the specified fill to a two-color gradient. Only applies for Excel 2007.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
color1 |
|
One gradient color. |
|
|
color2 |
|
Two gradient color. |
|
|
style |
Number |
|
GradientStyleType |
|
variant |
Number |
|
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 style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setTwoColorGradient(color1, transparency1, color2, transparency2, style, variant)
Sets the specified fill to a two-color gradient. Only applies for Excel 2007.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
color1 |
|
One gradient color. |
|
|
transparency1 |
Number |
|
The degree of transparency of the color1 as a value from 0.0 (opaque) through 1.0 (clear). |
|
color2 |
|
Two gradient color. |
|
|
transparency2 |
Number |
|
The degree of transparency of the color2 as a value from 0.0 (opaque) through 1.0 (clear). |
|
style |
Number |
|
GradientStyleType |
|
variant |
Number |
|
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 style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2. |
setType()
Gets and sets the fill type. The value of the property is FillType integer constant. NOTE: This member is now obsolete. Instead, please use FillFormat.FillType property instead. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
setWeight()
Gets or sets the weight of the line in unit of points.