com.aspose.slides

Class LineFormat

java.lang.Object

com.aspose.slides.PVIObject

com.aspose.slides.LineFormat

All Implemented Interfaces:

ILineFormat, ILineParamSource, IPresentationComponent, ISlideComponent

public final class LineFormat
extends PVIObject
implements ILineFormat

Represents format of a line.

Method Summary

Modifier and Type	Method and Description
boolean	equals(ILineFormat lineFormat) Determines whether the two LineFormat instances are equal.
boolean	equals(java.lang.Object obj) Compares with specified object.
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.
ISketchFormat	getSketchFormat() Returns the sketch format of a line.
byte	getStyle() Returns or sets the line style.
long	getVersion() Version.
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.

Methods inherited from class com.aspose.slides.PVIObject

getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVersion

public long getVersion()

Version. Read-only long.

Overrides:

getVersion in class PVIObject

equals

public boolean equals(java.lang.Object obj)

Description copied from class: PVIObject

Compares with specified object.

Overrides:

equals in class PVIObject

Parameters:

obj - Object to compare.

Returns:

True is objects are equal, otherwise false.

isFormatNotDefined

public final boolean isFormatNotDefined()

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

Specified by:

isFormatNotDefined in interface ILineFormat

getFillFormat

public final ILineFillFormat getFillFormat()

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

Specified by:

getFillFormat in interface ILineFormat

getSketchFormat

public final ISketchFormat getSketchFormat()

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

Specified by:

getSketchFormat in interface ILineFormat

getWidth

public final double getWidth()

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

Specified by:

getWidth in interface ILineFormat

setWidth

public final void setWidth(double value)

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

Specified by:

setWidth in interface ILineFormat

getDashStyle

public final byte getDashStyle()

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

Specified by:

getDashStyle in interface ILineFormat

setDashStyle

public final void setDashStyle(byte value)

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

Specified by:

setDashStyle in interface ILineFormat

getCustomDashPattern

public final float[] getCustomDashPattern()

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

Specified by:

getCustomDashPattern in interface ILineFormat

setCustomDashPattern

public final void setCustomDashPattern(float[] value)

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

Specified by:

setCustomDashPattern in interface ILineFormat

getCapStyle

public final byte getCapStyle()

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

Specified by:

getCapStyle in interface ILineFormat

setCapStyle

public final void setCapStyle(byte value)

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

Specified by:

setCapStyle in interface ILineFormat

getStyle

public final byte getStyle()

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

Specified by:

getStyle in interface ILineFormat

setStyle

public final void setStyle(byte value)

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

Specified by:

setStyle in interface ILineFormat

getAlignment

public final byte getAlignment()

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

Specified by:

getAlignment in interface ILineFormat

setAlignment

public final void setAlignment(byte value)

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

Specified by:

setAlignment in interface ILineFormat

getJoinStyle

public final byte getJoinStyle()

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

Specified by:

getJoinStyle in interface ILineFormat

setJoinStyle

public final void setJoinStyle(byte value)

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

Specified by:

setJoinStyle in interface ILineFormat

getMiterLimit

public final float getMiterLimit()

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

Specified by:

getMiterLimit in interface ILineFormat

setMiterLimit

public final void setMiterLimit(float value)

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

Specified by:

setMiterLimit in interface ILineFormat

getBeginArrowheadStyle

public final byte getBeginArrowheadStyle()

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

Specified by:

getBeginArrowheadStyle in interface ILineFormat

setBeginArrowheadStyle

public final void setBeginArrowheadStyle(byte value)

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

Specified by:

setBeginArrowheadStyle in interface ILineFormat

getEndArrowheadStyle

public final byte getEndArrowheadStyle()

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

Specified by:

getEndArrowheadStyle in interface ILineFormat

setEndArrowheadStyle

public final void setEndArrowheadStyle(byte value)

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

Specified by:

setEndArrowheadStyle in interface ILineFormat

getBeginArrowheadWidth

public final byte getBeginArrowheadWidth()

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

Specified by:

getBeginArrowheadWidth in interface ILineFormat

setBeginArrowheadWidth

public final void setBeginArrowheadWidth(byte value)

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

Specified by:

setBeginArrowheadWidth in interface ILineFormat

getEndArrowheadWidth

public final byte getEndArrowheadWidth()

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

Specified by:

getEndArrowheadWidth in interface ILineFormat

setEndArrowheadWidth

public final void setEndArrowheadWidth(byte value)

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

Specified by:

setEndArrowheadWidth in interface ILineFormat

getBeginArrowheadLength

public final byte getBeginArrowheadLength()

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

Specified by:

getBeginArrowheadLength in interface ILineFormat

setBeginArrowheadLength

public final void setBeginArrowheadLength(byte value)

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

Specified by:

setBeginArrowheadLength in interface ILineFormat

getEndArrowheadLength

public final byte getEndArrowheadLength()

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

Specified by:

getEndArrowheadLength in interface ILineFormat

setEndArrowheadLength

public final void setEndArrowheadLength(byte value)

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

Specified by:

setEndArrowheadLength in interface ILineFormat

equals

public final boolean equals(ILineFormat lineFormat)

Determines whether the two LineFormat instances are equal.

Specified by:

equals in interface ILineFormat

Parameters:

lineFormat - The LineFormat to compare with the current LineFormat.

Returns:

true if the specified LineFormat is equal to the current LineFormat; otherwise, false.

getEffective

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();
 }
 
 

Specified by:

getEffective in interface ILineFormat

Returns:

A ILineFormatEffectiveData.