public class LineFormat extends PVIObject implements ILineFormat
Represents format of a line.
Modifier and Type | Method and Description |
---|---|
boolean |
equals(ILineFormat lineFormat)
Determines whether the two LineFormat instances are equal.
|
byte |
getAlignment()
Returns or sets the line alignment.
|
byte |
getBeginArrowheadLength()
Returns or sets the arrowhead length at the beginning of a line.
|
byte |
getBeginArrowheadStyle()
Returns or sets the arrowhead style at the beginning of a line.
|
byte |
getBeginArrowheadWidth()
Returns or sets the arrowhead width at the beginning of a line.
|
byte |
getCapStyle()
Returns or sets the line cap style.
|
float[] |
getCustomDashPattern()
Returns or sets the custom dash pattern.
|
byte |
getDashStyle()
Returns or sets the line dash style.
|
ILineFormatEffectiveData |
getEffective()
Gets effective line formatting data with the inheritance applied.
|
byte |
getEndArrowheadLength()
Returns or sets the arrowhead length at the end of a line.
|
byte |
getEndArrowheadStyle()
Returns or sets the arrowhead style at the end of a line.
|
byte |
getEndArrowheadWidth()
Returns or sets the arrowhead width at the end of a line.
|
ILineFillFormat |
getFillFormat()
Returns the fill format of a line.
|
byte |
getJoinStyle()
Returns or sets the lines join style.
|
float |
getMiterLimit()
Returns or sets the miter limit of a line.
|
byte |
getStyle()
Returns or sets the line style.
|
double |
getWidth()
Returns or sets the width of a line.
|
boolean |
isFormatNotDefined()
Returns true if line format is not defined (as just created, default).
|
void |
setAlignment(byte value)
Returns or sets the line alignment.
|
void |
setBeginArrowheadLength(byte value)
Returns or sets the arrowhead length at the beginning of a line.
|
void |
setBeginArrowheadStyle(byte value)
Returns or sets the arrowhead style at the beginning of a line.
|
void |
setBeginArrowheadWidth(byte value)
Returns or sets the arrowhead width at the beginning of a line.
|
void |
setCapStyle(byte value)
Returns or sets the line cap style.
|
void |
setCustomDashPattern(float[] value)
Returns or sets the custom dash pattern.
|
void |
setDashStyle(byte value)
Returns or sets the line dash style.
|
void |
setEndArrowheadLength(byte value)
Returns or sets the arrowhead length at the end of a line.
|
void |
setEndArrowheadStyle(byte value)
Returns or sets the arrowhead style at the end of a line.
|
void |
setEndArrowheadWidth(byte value)
Returns or sets the arrowhead width at the end of a line.
|
void |
setJoinStyle(byte value)
Returns or sets the lines join style.
|
void |
setMiterLimit(float value)
Returns or sets the miter limit of a line.
|
void |
setStyle(byte value)
Returns or sets the line style.
|
void |
setWidth(double value)
Returns or sets the width of a line.
|
equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, getVersion, hashCode, reset_Parent_IPresentationComponent
public final boolean isFormatNotDefined()
Returns true if line format is not defined (as just created, default).
Read-only boolean
.
isFormatNotDefined
in interface ILineFormat
public final ILineFillFormat getFillFormat()
Returns the fill format of a line.
Read-only ILineFillFormat
.
getFillFormat
in interface ILineFormat
public final double getWidth()
Returns or sets the width of a line.
Read/write double
.
getWidth
in interface ILineFormat
public final void setWidth(double value)
Returns or sets the width of a line.
Read/write double
.
setWidth
in interface ILineFormat
public final byte getDashStyle()
Returns or sets the line dash style.
Read/write LineDashStyle
.
getDashStyle
in interface ILineFormat
public final void setDashStyle(byte value)
Returns or sets the line dash style.
Read/write LineDashStyle
.
setDashStyle
in interface ILineFormat
public final float[] getCustomDashPattern()
Returns or sets the custom dash pattern.
Read/write float[]
.
getCustomDashPattern
in interface ILineFormat
public final void setCustomDashPattern(float[] value)
Returns or sets the custom dash pattern.
Read/write float[]
.
setCustomDashPattern
in interface ILineFormat
public final byte getCapStyle()
Returns or sets the line cap style.
Read/write LineCapStyle
.
getCapStyle
in interface ILineFormat
public final void setCapStyle(byte value)
Returns or sets the line cap style.
Read/write LineCapStyle
.
setCapStyle
in interface ILineFormat
public final byte getStyle()
Returns or sets the line style.
Read/write LineStyle
.
getStyle
in interface ILineFormat
public final void setStyle(byte value)
Returns or sets the line style.
Read/write LineStyle
.
setStyle
in interface ILineFormat
public final byte getAlignment()
Returns or sets the line alignment.
Read/write LineAlignment
.
getAlignment
in interface ILineFormat
public final void setAlignment(byte value)
Returns or sets the line alignment.
Read/write LineAlignment
.
setAlignment
in interface ILineFormat
public final byte getJoinStyle()
Returns or sets the lines join style.
Read/write LineJoinStyle
.
getJoinStyle
in interface ILineFormat
public final void setJoinStyle(byte value)
Returns or sets the lines join style.
Read/write LineJoinStyle
.
setJoinStyle
in interface ILineFormat
public final float getMiterLimit()
Returns or sets the miter limit of a line.
Read/write float
.
getMiterLimit
in interface ILineFormat
public final void setMiterLimit(float value)
Returns or sets the miter limit of a line.
Read/write float
.
setMiterLimit
in interface ILineFormat
public final byte getBeginArrowheadStyle()
Returns or sets the arrowhead style at the beginning of a line.
Read/write LineArrowheadStyle
.
getBeginArrowheadStyle
in interface ILineFormat
public final void setBeginArrowheadStyle(byte value)
Returns or sets the arrowhead style at the beginning of a line.
Read/write LineArrowheadStyle
.
setBeginArrowheadStyle
in interface ILineFormat
public final byte getEndArrowheadStyle()
Returns or sets the arrowhead style at the end of a line.
Read/write LineArrowheadStyle
.
getEndArrowheadStyle
in interface ILineFormat
public final void setEndArrowheadStyle(byte value)
Returns or sets the arrowhead style at the end of a line.
Read/write LineArrowheadStyle
.
setEndArrowheadStyle
in interface ILineFormat
public final byte getBeginArrowheadWidth()
Returns or sets the arrowhead width at the beginning of a line.
Read/write LineArrowheadWidth
.
getBeginArrowheadWidth
in interface ILineFormat
public final void setBeginArrowheadWidth(byte value)
Returns or sets the arrowhead width at the beginning of a line.
Read/write LineArrowheadWidth
.
setBeginArrowheadWidth
in interface ILineFormat
public final byte getEndArrowheadWidth()
Returns or sets the arrowhead width at the end of a line.
Read/write LineArrowheadWidth
.
getEndArrowheadWidth
in interface ILineFormat
public final void setEndArrowheadWidth(byte value)
Returns or sets the arrowhead width at the end of a line.
Read/write LineArrowheadWidth
.
setEndArrowheadWidth
in interface ILineFormat
public final byte getBeginArrowheadLength()
Returns or sets the arrowhead length at the beginning of a line.
Read/write LineArrowheadLength
.
getBeginArrowheadLength
in interface ILineFormat
public final void setBeginArrowheadLength(byte value)
Returns or sets the arrowhead length at the beginning of a line.
Read/write LineArrowheadLength
.
setBeginArrowheadLength
in interface ILineFormat
public final byte getEndArrowheadLength()
Returns or sets the arrowhead length at the end of a line.
Read/write LineArrowheadLength
.
getEndArrowheadLength
in interface ILineFormat
public final void setEndArrowheadLength(byte value)
Returns or sets the arrowhead length at the end of a line.
Read/write LineArrowheadLength
.
setEndArrowheadLength
in interface ILineFormat
public final boolean equals(ILineFormat lineFormat)
Determines whether the two LineFormat instances are equal.
equals
in interface ILineFormat
lineFormat
- The LineFormat to compare with the current LineFormat.<b>true</b>
if the specified LineFormat is equal to the current LineFormat;
otherwise, <b>false</b>
.public final ILineFormatEffectiveData getEffective()
Gets effective line formatting data with the inheritance applied.
This example demonstrates getting shape's effective line format properties.Presentation pres = new Presentation("MyPresentation.pptx"); try { ILineFormatEffectiveData effectiveLineFormat = pres.getSlides().get_Item(0).getShapes().get_Item(0).getLineFormat().getEffective(); System.out.println("Style: " + effectiveLineFormat.getStyle()); System.out.println("Width: " + effectiveLineFormat.getWidth()); System.out.println("Fill type: " + effectiveLineFormat.getFillFormat().getFillType()); } finally { if (pres != null) pres.dispose(); }
getEffective
in interface ILineFormat
ILineFormatEffectiveData
.