ShapeGuide Class

A guide used to govern the geometry of a shape

Declaration

public final class ShapeGuide extends Struct<ShapeGuide> implements IEquatable<ShapeGuide>

Implements

com.devexpress.system.IEquatable<com.devexpress.docs.presentation.ShapeGuide>

Inherited Members

com.devexpress.system.Struct.equals(java.lang.Object)

com.devexpress.system.Struct.getHashCode()

com.devexpress.system.Struct.hashCode()

java.lang.Object.clone()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.toString()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.Struct

ShapeGuide

Constructors

ShapeGuide() Constructor

Initializes a new instance of the ShapeGuide class.

Declaration

public ShapeGuide()

ShapeGuide(String name, ShapeGuideFormula formula) Constructor

Initializes a new instance of the ShapeGuide class with specified settings.

Declaration

public ShapeGuide(String name, ShapeGuideFormula formula)

Parameters

Name	Type	Description
name	String	The guide name.
formula	ShapeGuideFormula	The guide formula.

Methods

equals(Object obj) Method

Determines whether the specified object is equal to the current ShapeGuide instance.

Declaration

public boolean equals(Object obj)

Parameters

Name	Type	Description
obj	Object	The object to compare with the ShapeGuide instance.

Returns

Type	Description
boolean	true if the specified object is equal to the current ShapeGuide instance; otherwise, false.

equals(ShapeGuide other) Method

Indicates whether the current ShapeGuide instance is equal to another ShapeGuide instance.

Declaration

public boolean equals(ShapeGuide other)

Parameters

Name	Type	Description
other	ShapeGuide	The ShapeGuide instance to compare.

Returns

Type	Description
boolean	true if the current instance is equal to the specified ShapeGuide instance; otherwise, false.

getFormula() Method

Returns the formula associated with the shape guide.

Declaration

public ShapeGuideFormula getFormula()

Returns

Type	Description
ShapeGuideFormula	The guide formula.

getName() Method

Returns the name of the shape guide.

Declaration

public String getName()

Returns

Type	Description
String	The guide name.

hashCode() Method

Returns a hash code for this ShapeGuide object.

Declaration

public int hashCode()

Returns

Type	Description
int	The identification number.