com.aspose.words

Class HorizontalRuleFormat

java.lang.Object

com.aspose.words.HorizontalRuleFormat

public class HorizontalRuleFormat
extends java.lang.Object

Represents horizontal rule formatting.

To learn more, visit the Working with Shapes documentation article.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Method Summary

Modifier and Type	Method and Description
int	getAlignment() Gets the alignment of the horizontal rule.
java.awt.Color	getColor() Gets the brush color that fills the horizontal rule.
double	getHeight() Gets the height of the horizontal rule.
boolean	getNoShade() Indicates the presence of 3D shading for the horizontal rule.
double	getWidthPercent() Gets the length of the specified horizontal rule expressed as a percentage of the window width.
void	setAlignment(int value) Sets the alignment of the horizontal rule.
void	setColor(java.awt.Color value) Sets the brush color that fills the horizontal rule.
void	setHeight(double value) Sets the height of the horizontal rule.
void	setNoShade(boolean value) Indicates the presence of 3D shading for the horizontal rule.
void	setWidthPercent(double value) Sets the length of the specified horizontal rule expressed as a percentage of the window width.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getWidthPercent

public double getWidthPercent()

Gets the length of the specified horizontal rule expressed as a percentage of the window width.

Returns:

The length of the specified horizontal rule expressed as a percentage of the window width.

Throws:

java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.

Remarks:

Valid values range from 1 to 100 inclusive.

The default value is 100.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

setWidthPercent

public void setWidthPercent(double value)

Sets the length of the specified horizontal rule expressed as a percentage of the window width.

Parameters:

value - The length of the specified horizontal rule expressed as a percentage of the window width.

Throws:

java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.

Remarks:

Valid values range from 1 to 100 inclusive.

The default value is 100.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

getHeight

public double getHeight()

Gets the height of the horizontal rule.

Returns:

The height of the horizontal rule.

Throws:

java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.

Remarks:

This is a shortcut to the ShapeBase.getHeight() / ShapeBase.setHeight(double) property.

Valid values range from 0 to 1584 inclusive.

The default value is 1.5.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

setHeight

public void setHeight(double value)
               throws java.lang.Exception

Sets the height of the horizontal rule.

Parameters:

value - The height of the horizontal rule.

Throws:

java.lang.IllegalArgumentException - Throws when argument was out of the range of valid values.

Remarks:

This is a shortcut to the ShapeBase.getHeight() / ShapeBase.setHeight(double) property.

Valid values range from 0 to 1584 inclusive.

The default value is 1.5.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

java.lang.Exception

getNoShade

public boolean getNoShade()

Indicates the presence of 3D shading for the horizontal rule. If true, then the horizontal rule is without 3D shading and solid color is used.

Remarks:

The default value is false.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Returns:

The corresponding boolean value.

setNoShade

public void setNoShade(boolean value)

Indicates the presence of 3D shading for the horizontal rule. If true, then the horizontal rule is without 3D shading and solid color is used.

Remarks:

The default value is false.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Parameters:

value - The corresponding boolean value.

getColor

public java.awt.Color getColor()

Gets the brush color that fills the horizontal rule.

Remarks:

This is a shortcut to the Fill.getColor() / Fill.setColor(java.awt.Color) property.

The default value is java.awt.Color#getGray().

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Returns:

The brush color that fills the horizontal rule.

setColor

public void setColor(java.awt.Color value)

Sets the brush color that fills the horizontal rule.

Remarks:

This is a shortcut to the Fill.getColor() / Fill.setColor(java.awt.Color) property.

The default value is java.awt.Color#getGray().

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Parameters:

value - The brush color that fills the horizontal rule.

getAlignment

public int getAlignment()

Gets the alignment of the horizontal rule.

Remarks:

The default value is HorizontalRuleAlignment.LEFT.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Returns:

The alignment of the horizontal rule. The returned value is one of HorizontalRuleAlignment constants.

setAlignment

public void setAlignment(int value)

Sets the alignment of the horizontal rule.

Remarks:

The default value is HorizontalRuleAlignment.LEFT.

Examples:

Shows how to insert a horizontal rule shape, and customize its formatting.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);
 Shape shape = builder.insertHorizontalRule();

 HorizontalRuleFormat horizontalRuleFormat = shape.getHorizontalRuleFormat();
 horizontalRuleFormat.setAlignment(HorizontalRuleAlignment.CENTER);
 horizontalRuleFormat.setWidthPercent(70.0);
 horizontalRuleFormat.setHeight(3.0);
 horizontalRuleFormat.setColor(Color.BLUE);
 horizontalRuleFormat.setNoShade(true);

 Assert.assertTrue(shape.isHorizontalRule());
 Assert.assertTrue(shape.getHorizontalRuleFormat().getNoShade());
 
 

Parameters:

value - The alignment of the horizontal rule. The value must be one of HorizontalRuleAlignment constants.