ILineFormat

All Implemented Interfaces: com.aspose.slides.ILineParamSource

public interface ILineFormat extends ILineParamSource

Represents format of a line.

Methods

Method	Description
isFormatNotDefined()	Returns true if line format is not defined (as just created, default).
getFillFormat()	Returns the fill format of a line.
getSketchFormat()	Returns the sketch format of a line.
getWidth()	Returns or sets the width of a line.
setWidth(double value)	Returns or sets the width of a line.
getDashStyle()	Returns or sets the line dash style.
setDashStyle(byte value)	Returns or sets the line dash style.
getCustomDashPattern()	Returns or sets the custom dash pattern.
setCustomDashPattern(float[] value)	Returns or sets the custom dash pattern.
getCapStyle()	Returns or sets the line cap style.
setCapStyle(byte value)	Returns or sets the line cap style.
getStyle()	Returns or sets the line style.
setStyle(byte value)	Returns or sets the line style.
getAlignment()	Returns or sets the line alignment.
setAlignment(byte value)	Returns or sets the line alignment.
getJoinStyle()	Returns or sets the lines join style.
setJoinStyle(byte value)	Returns or sets the lines join style.
getMiterLimit()	Returns or sets the miter limit of a line.
setMiterLimit(float value)	Returns or sets the miter limit of a line.
getBeginArrowheadStyle()	Returns or sets the arrowhead style at the beginning of a line.
setBeginArrowheadStyle(byte value)	Returns or sets the arrowhead style at the beginning of a line.
getEndArrowheadStyle()	Returns or sets the arrowhead style at the end of a line.
setEndArrowheadStyle(byte value)	Returns or sets the arrowhead style at the end of a line.
getBeginArrowheadWidth()	Returns or sets the arrowhead width at the beginning of a line.
setBeginArrowheadWidth(byte value)	Returns or sets the arrowhead width at the beginning of a line.
getEndArrowheadWidth()	Returns or sets the arrowhead width at the end of a line.
setEndArrowheadWidth(byte value)	Returns or sets the arrowhead width at the end of a line.
getBeginArrowheadLength()	Returns or sets the arrowhead length at the beginning of a line.
setBeginArrowheadLength(byte value)	Returns or sets the arrowhead length at the beginning of a line.
getEndArrowheadLength()	Returns or sets the arrowhead length at the end of a line.
setEndArrowheadLength(byte value)	Returns or sets the arrowhead length at the end of a line.
equals(ILineFormat lineFormat)	Determines whether the two LineFormat instances are equal.
getEffective()	Gets effective line formatting data with the inheritance applied.

isFormatNotDefined()

public abstract boolean isFormatNotDefined()

Returns true if line format is not defined (as just created, default). Read-only boolean.

Returns: boolean

getFillFormat()

public abstract ILineFillFormat getFillFormat()

Returns the fill format of a line. Read-only ILineFillFormat.

Returns: ILineFillFormat

getSketchFormat()

public abstract ISketchFormat getSketchFormat()

Returns the sketch format of a line. Read-only ISketchFormat.

Returns: ISketchFormat

getWidth()

public abstract double getWidth()

Returns or sets the width of a line. Read/write double.

Returns: double

setWidth(double value)

public abstract void setWidth(double value)

Returns or sets the width of a line. Read/write double.

Parameters:

Parameter	Type	Description
value	double

getDashStyle()

public abstract byte getDashStyle()

Returns or sets the line dash style. Read/write LineDashStyle.

Returns: byte

setDashStyle(byte value)

public abstract void setDashStyle(byte value)

Returns or sets the line dash style. Read/write LineDashStyle.

Parameters:

Parameter	Type	Description
value	byte

getCustomDashPattern()

public abstract float[] getCustomDashPattern()

Returns or sets the custom dash pattern. Read/write float[].

Returns: float[]

setCustomDashPattern(float[] value)

public abstract void setCustomDashPattern(float[] value)

Returns or sets the custom dash pattern. Read/write float[].

Parameters:

Parameter	Type	Description
value	float[]

getCapStyle()

public abstract byte getCapStyle()

Returns or sets the line cap style. Read/write LineCapStyle.

Returns: byte

setCapStyle(byte value)

public abstract void setCapStyle(byte value)

Returns or sets the line cap style. Read/write LineCapStyle.

Parameters:

Parameter	Type	Description
value	byte

getStyle()

public abstract byte getStyle()

Returns or sets the line style. Read/write LineStyle.

Returns: byte

setStyle(byte value)

public abstract void setStyle(byte value)

Returns or sets the line style. Read/write LineStyle.

Parameters:

Parameter	Type	Description
value	byte

getAlignment()

public abstract byte getAlignment()

Returns or sets the line alignment. Read/write LineAlignment.

Returns: byte

setAlignment(byte value)

public abstract void setAlignment(byte value)

Returns or sets the line alignment. Read/write LineAlignment.

Parameters:

Parameter	Type	Description
value	byte

getJoinStyle()

public abstract byte getJoinStyle()

Returns or sets the lines join style. Read/write LineJoinStyle.

Returns: byte

setJoinStyle(byte value)

public abstract void setJoinStyle(byte value)

Returns or sets the lines join style. Read/write LineJoinStyle.

Parameters:

Parameter	Type	Description
value	byte

getMiterLimit()

public abstract float getMiterLimit()

Returns or sets the miter limit of a line. Read/write float.

Returns: float

setMiterLimit(float value)

public abstract void setMiterLimit(float value)

Returns or sets the miter limit of a line. Read/write float.

Parameters:

Parameter	Type	Description
value	float

getBeginArrowheadStyle()

public abstract byte getBeginArrowheadStyle()

Returns or sets the arrowhead style at the beginning of a line. Read/write LineArrowheadStyle.

Returns: byte

setBeginArrowheadStyle(byte value)

public abstract void setBeginArrowheadStyle(byte value)

Returns or sets the arrowhead style at the beginning of a line. Read/write LineArrowheadStyle.

Parameters:

Parameter	Type	Description
value	byte

getEndArrowheadStyle()

public abstract byte getEndArrowheadStyle()

Returns or sets the arrowhead style at the end of a line. Read/write LineArrowheadStyle.

Returns: byte

setEndArrowheadStyle(byte value)

public abstract void setEndArrowheadStyle(byte value)

Returns or sets the arrowhead style at the end of a line. Read/write LineArrowheadStyle.

Parameters:

Parameter	Type	Description
value	byte

getBeginArrowheadWidth()

public abstract byte getBeginArrowheadWidth()

Returns or sets the arrowhead width at the beginning of a line. Read/write LineArrowheadWidth.

Returns: byte

setBeginArrowheadWidth(byte value)

public abstract void setBeginArrowheadWidth(byte value)

Returns or sets the arrowhead width at the beginning of a line. Read/write LineArrowheadWidth.

Parameters:

Parameter	Type	Description
value	byte

getEndArrowheadWidth()

public abstract byte getEndArrowheadWidth()

Returns or sets the arrowhead width at the end of a line. Read/write LineArrowheadWidth.

Returns: byte

setEndArrowheadWidth(byte value)

public abstract void setEndArrowheadWidth(byte value)

Returns or sets the arrowhead width at the end of a line. Read/write LineArrowheadWidth.

Parameters:

Parameter	Type	Description
value	byte

getBeginArrowheadLength()

public abstract byte getBeginArrowheadLength()

Returns or sets the arrowhead length at the beginning of a line. Read/write LineArrowheadLength.

Returns: byte

setBeginArrowheadLength(byte value)

public abstract void setBeginArrowheadLength(byte value)

Returns or sets the arrowhead length at the beginning of a line. Read/write LineArrowheadLength.

Parameters:

Parameter	Type	Description
value	byte

getEndArrowheadLength()

public abstract byte getEndArrowheadLength()

Returns or sets the arrowhead length at the end of a line. Read/write LineArrowheadLength.

Returns: byte

setEndArrowheadLength(byte value)

public abstract void setEndArrowheadLength(byte value)

Returns or sets the arrowhead length at the end of a line. Read/write LineArrowheadLength.

Parameters:

Parameter	Type	Description
value	byte

equals(ILineFormat lineFormat)

public abstract boolean equals(ILineFormat lineFormat)

Determines whether the two LineFormat instances are equal.

Parameters:

Parameter	Type	Description
lineFormat	ILineFormat	The LineFormat to compare with the current LineFormat.

Returns: boolean - true if the specified LineFormat is equal to the current LineFormat; otherwise, false.

getEffective()

public abstract ILineFormatEffectiveData getEffective()

Gets effective line formatting data with the inheritance applied.

Returns: ILineFormatEffectiveData - A ILineFormatEffectiveData.