LineFormat

LineFormat class

Represents format of a line.

equals

NameDescription
equals(Object)

Returns: boolean


equals

NameDescription
equals(LineFormat)Determines whether the two LineFormat instances are equal.

Parameters:

NameTypeDescription
lineFormatLineFormatThe LineFormat to compare with the current LineFormat.

Returns: boolean


getAlignment

NameDescription
getAlignment()Returns or sets the line alignment. Read/write LineAlignment.

Returns: byte


getBeginArrowheadLength

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

Returns: byte


getBeginArrowheadStyle

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

Returns: byte


getBeginArrowheadWidth

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

Returns: byte


getCapStyle

NameDescription
getCapStyle()Returns or sets the line cap style. Read/write LineCapStyle.

Returns: byte


getCustomDashPattern

NameDescription
getCustomDashPattern()Returns or sets the custom dash pattern. Read/write float[].

Returns: float


getDashStyle

NameDescription
getDashStyle()Returns or sets the line dash style. Read/write LineDashStyle.

Returns: byte


getEffective

NameDescription
getEffective()Gets effective line formatting data with the inheritance applied.

Returns: LineFormatEffectiveData


getEndArrowheadLength

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

Returns: byte


getEndArrowheadStyle

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

Returns: byte


getEndArrowheadWidth

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

Returns: byte


getFillFormat

NameDescription
getFillFormat()Returns the fill format of a line. Read-only ILineFillFormat.

Returns: LineFillFormat


getJoinStyle

NameDescription
getJoinStyle()Returns or sets the lines join style. Read/write LineJoinStyle.

Returns: byte


getMiterLimit

NameDescription
getMiterLimit()Returns or sets the miter limit of a line. Read/write float.

Returns: float


getSketchFormat

NameDescription
getSketchFormat()Returns the sketch format of a line. Read-only ILineFillFormat.

Returns: SketchFormat


getStyle

NameDescription
getStyle()Returns or sets the line style. Read/write LineStyle.

Returns: byte


getVersion

NameDescription
getVersion()

Returns: long


getWidth

NameDescription
getWidth()Returns or sets the width of a line. Read/write double.

Returns: double


isFormatNotDefined

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

Returns: boolean


setAlignment

NameDescription
setAlignment(byte)Returns or sets the line alignment. Read/write LineAlignment.

setBeginArrowheadLength

NameDescription
setBeginArrowheadLength(byte)Returns or sets the arrowhead length at the beginning of a line. Read/write LineArrowheadLength.

setBeginArrowheadStyle

NameDescription
setBeginArrowheadStyle(byte)Returns or sets the arrowhead style at the beginning of a line. Read/write LineArrowheadStyle.

setBeginArrowheadWidth

NameDescription
setBeginArrowheadWidth(byte)Returns or sets the arrowhead width at the beginning of a line. Read/write LineArrowheadWidth.

setCapStyle

NameDescription
setCapStyle(byte)Returns or sets the line cap style. Read/write LineCapStyle.

setCustomDashPattern

NameDescription
setCustomDashPattern(float[])Returns or sets the custom dash pattern. Read/write float[].

setDashStyle

NameDescription
setDashStyle(byte)Returns or sets the line dash style. Read/write LineDashStyle.

setEndArrowheadLength

NameDescription
setEndArrowheadLength(byte)Returns or sets the arrowhead length at the end of a line. Read/write LineArrowheadLength.

setEndArrowheadStyle

NameDescription
setEndArrowheadStyle(byte)Returns or sets the arrowhead style at the end of a line. Read/write LineArrowheadStyle.

setEndArrowheadWidth

NameDescription
setEndArrowheadWidth(byte)Returns or sets the arrowhead width at the end of a line. Read/write LineArrowheadWidth.

setJoinStyle

NameDescription
setJoinStyle(byte)Returns or sets the lines join style. Read/write LineJoinStyle.

setMiterLimit

NameDescription
setMiterLimit(float)Returns or sets the miter limit of a line. Read/write float.

setStyle

NameDescription
setStyle(byte)Returns or sets the line style. Read/write LineStyle.

setWidth

NameDescription
setWidth(double)Returns or sets the width of a line. Read/write double.