com.spire.doc.formatting
Class ParagraphFormat

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.formatting.FormatBase
              com.spire.doc.formatting.AttrCollection
                  com.spire.doc.formatting.WordAttrCollection
                      com.spire.doc.formatting.ParagraphFormat

public class ParagraphFormat
extends WordAttrCollection

Constructor Summary

ParagraphFormat()
Initializes a new instance of the ParagraphFormat class.

ParagraphFormat(IDocument document)
Initializes a new instance of the ParagraphFormatclass.

Method Summary

boolean	getAfterAutoSpacing() Gets a value indicating whether spacing after is automatic.
float	getAfterSpacing() Returns the spacing (in points) after the paragraph.
boolean	getAutoSpaceDE() Gets the value that determines whether the space is automatically adjusted between Asian and Latin text.
boolean	getAutoSpaceDN() Gets the value that determines whether the space is automatically adjusted between Asian text and numbers.
java.awt.Color	getBackColor() Gets background color of the paragraph
boolean	getBeforeAutoSpacing() Gets a value indicating whether spacing before is automatic.
float	getBeforeSpacing() Returns the spacing (in points) before the paragraph.
Borders	getBorders() Gets collection of borders in the paragraph
float	getFirstLineIndent() Gets first paragraph line indent
HorizontalAlignment	getHorizontalAlignment() Returns horizontal alignment for the paragraph.
boolean	getKeepFollow() True if the paragraph is to remains on the same page as the paragraph that follows it.
boolean	getKeepLines() True if all lines in the paragraph are to remain on the same page.
float	getLeftIndent() Returns the value that represents the left indent for paragraph.
float	getLineSpacing() Returns line spacing property of the paragraph.
LineSpacingRule	getLineSpacingRule() Returns line spacing rule property of the paragraph.
boolean	getMirrorIndents() Gets a value indicating whether indentation type is mirror indents.
OutlineLevel	getOutlineLevel() Gets the outline level.
boolean	getOverflowPunc() Gets allow punctuation to extend past text extents.
boolean	getPageBreakAfter() True if a page break is forced after the paragraph
boolean	getPageBreakBefore() True if a page break is forced before the paragraph
float	getRightIndent() Returns the value that represents the right indent for paragraph.
boolean	getSuppressAutoHyphens() Indicates whether to suppress automatic hyphenation for the paragraph.
TabCollection	getTabs() Gets the tabs info.
TextAlignment	getTextAlignment() Gets the style of textalignment
boolean	isBidi() Returns right-to-left property of the paragraph.
void	isBidi(boolean value) Sets right-to-left property of the paragraph.
boolean	isColumnBreakAfter() True if a column break is forced after the paragraph
void	isColumnBreakAfter(boolean value) True if a column break is forced after the paragraph
boolean	isFrame() Gets a value indicating whether this instance is frame.
boolean	isKinSoku() Get a value that determines whether use Asian rules for controlling first and last characters.
void	isKinSoku(boolean value) Set a value that determines whether use Asian rules for controlling first and last characters.
boolean	isWidowControl() True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
void	isWidowControl(boolean value) True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
void	setAfterAutoSpacing(boolean value) Sets a value indicating whether spacing after is automatic.
void	setAfterSpacing(float value) Sets the spacing (in points) after the paragraph.
void	setAutoSpaceDE(boolean value) Sets the value that determines whether the space is automatically adjusted between Asian and Latin text.
void	setAutoSpaceDN(boolean value) Sets the value that determines whether the space is automatically adjusted between Asian text and numbers.
void	setBackColor(java.awt.Color value) Sets background color of the paragraph
void	setBeforeAutoSpacing(boolean value) Sets a value indicating whether spacing before is automatic.
void	setBeforeSpacing(float value) Sets the spacing (in points) before the paragraph.
void	setFirstLineIndent(float value) Sets first paragraph line indent
void	setFirstLineIndentEx(float firstLineIndent) Sets the value that represents the first line indent for paragraph.
void	setHorizontalAlignment(HorizontalAlignment value) Sets horizontal alignment for the paragraph.
void	setKeepFollow(boolean value) True if the paragraph is to remains on the same page as the paragraph that follows it.
void	setKeepLines(boolean value) True if all lines in the paragraph are to remain on the same page.
void	setLeftIndent(float value) Sets the value that represents the left indent for paragraph.
void	setLeftIndentEx(float leftIndent) Sets the value that represents the left indent for paragraph.
void	setLineSpacing(float value) Sets line spacing property of the paragraph.
void	setLineSpacingRule(LineSpacingRule value) Sets line spacing rule property of the paragraph.
void	setMirrorIndents(boolean value) Sets a value indicating whether indentation type is mirror indents.
void	setOutlineLevel(OutlineLevel value) Sets the outline level.
void	setOverflowPunc(boolean value) Sets allow punctuation to extend past text extents.
void	setPageBreakAfter(boolean value) True if a page break is forced after the paragraph
void	setPageBreakBefore(boolean value) True if a page break is forced before the paragraph
void	setRightIndent(float value) Sets the value that represents the right indent for paragraph.
void	setRightIndentEx(float rightIndent) Sets the value that represents the right indent for paragraph.
void	setSuppressAutoHyphens(boolean value) Indicates whether to suppress automatic hyphenation for the paragraph.
void	setTextAlignment(TextAlignment value) Sets the style of textalignment

Methods inherited from class com.spire.doc.formatting.FormatBase

clearFormatting, hasKey, isDefault

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

ParagraphFormat

public ParagraphFormat()

Initializes a new instance of the ParagraphFormat class.

ParagraphFormat

public ParagraphFormat(IDocument document)

Initializes a new instance of the ParagraphFormatclass.

Parameters:

document - IDocument

Method Detail

isKinSoku

public boolean isKinSoku()

Get a value that determines whether use Asian rules for controlling first and last characters.

Returns:

boolean

isKinSoku

public void isKinSoku(boolean value)

Set a value that determines whether use Asian rules for controlling first and last characters.

Parameters:

value - boolean

isBidi

public boolean isBidi()

Returns right-to-left property of the paragraph.

Returns:

isBidi

isBidi

public void isBidi(boolean value)

Sets right-to-left property of the paragraph.

Parameters:

value - if bidi, set to true.

getTabs

public TabCollection getTabs()

Gets the tabs info.

Returns:

The tabs info.

getKeepLines

public boolean getKeepLines()

True if all lines in the paragraph are to remain on the same page.

Returns:

KeepLines

setKeepLines

public void setKeepLines(boolean value)

True if all lines in the paragraph are to remain on the same page.

Parameters:

value - KeepLines

getKeepFollow

public boolean getKeepFollow()

True if the paragraph is to remains on the same page as the paragraph that follows it.

Returns:

KeepFollow

setKeepFollow

public void setKeepFollow(boolean value)

True if the paragraph is to remains on the same page as the paragraph that follows it.

Parameters:

value - KeepFollow

getPageBreakBefore

public boolean getPageBreakBefore()

True if a page break is forced before the paragraph

Returns:

PageBreakBefore

setPageBreakBefore

public void setPageBreakBefore(boolean value)

True if a page break is forced before the paragraph

Parameters:

value - PageBreakBefore

getPageBreakAfter

public boolean getPageBreakAfter()

True if a page break is forced after the paragraph

Returns:

PageBreakAfter

setPageBreakAfter

public void setPageBreakAfter(boolean value)

True if a page break is forced after the paragraph

Parameters:

value - PageBreakAfter

isWidowControl

public boolean isWidowControl()

True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.

Returns:

WidowControl

isWidowControl

public void isWidowControl(boolean value)

True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.

Parameters:

value - WidowControl

getAutoSpaceDN

public boolean getAutoSpaceDN()

Gets the value that determines whether the space is automatically adjusted between Asian text and numbers.

Returns:

boolean

setAutoSpaceDN

public void setAutoSpaceDN(boolean value)

Sets the value that determines whether the space is automatically adjusted between Asian text and numbers.

Parameters:

value - boolean

getAutoSpaceDE

public boolean getAutoSpaceDE()

Gets the value that determines whether the space is automatically adjusted between Asian and Latin text.

Returns:

boolean

setAutoSpaceDE

public void setAutoSpaceDE(boolean value)

Sets the value that determines whether the space is automatically adjusted between Asian and Latin text.

Parameters:

value - boolean

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Returns horizontal alignment for the paragraph.

Returns:

HorizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment value)

Sets horizontal alignment for the paragraph.

Parameters:

value - HorizontalAlignment

getLeftIndent

public float getLeftIndent()

Returns the value that represents the left indent for paragraph.

Returns:

float

setLeftIndent

public void setLeftIndent(float value)

Sets the value that represents the left indent for paragraph.

Parameters:

value - float

getRightIndent

public float getRightIndent()

Returns the value that represents the right indent for paragraph.

Returns:

float

setRightIndent

public void setRightIndent(float value)

Sets the value that represents the right indent for paragraph.

Parameters:

value - float

getFirstLineIndent

public float getFirstLineIndent()

Gets first paragraph line indent

Returns:

float

setFirstLineIndent

public void setFirstLineIndent(float value)

Sets first paragraph line indent

Parameters:

value - float

getBeforeSpacing

public float getBeforeSpacing()

Returns the spacing (in points) before the paragraph.

Returns:

float

setBeforeSpacing

public void setBeforeSpacing(float value)

Sets the spacing (in points) before the paragraph.

Parameters:

value - float

getAfterSpacing

public float getAfterSpacing()

Returns the spacing (in points) after the paragraph.

Returns:

float

setAfterSpacing

public void setAfterSpacing(float value)

Sets the spacing (in points) after the paragraph.

Parameters:

value - float

getBorders

public Borders getBorders()

Gets collection of borders in the paragraph

Returns:

Borders

getBackColor

public java.awt.Color getBackColor()

Gets background color of the paragraph

Returns:

Color

setBackColor

public void setBackColor(java.awt.Color value)

Sets background color of the paragraph

Parameters:

value - Color

isColumnBreakAfter

public boolean isColumnBreakAfter()

True if a column break is forced after the paragraph

Returns:

is ColumnBreakAfter or not

isColumnBreakAfter

public void isColumnBreakAfter(boolean value)

True if a column break is forced after the paragraph

Parameters:

value - is ColumnBreakAfter or not

getLineSpacing

public float getLineSpacing()

Returns line spacing property of the paragraph.

Returns:

LineSpacing

setLineSpacing

public void setLineSpacing(float value)

Sets line spacing property of the paragraph.

Parameters:

value - LineSpacing

getLineSpacingRule

public LineSpacingRule getLineSpacingRule()

Returns line spacing rule property of the paragraph.

Returns:

LineSpacingRule

setLineSpacingRule

public void setLineSpacingRule(LineSpacingRule value)

Sets line spacing rule property of the paragraph.

Parameters:

value - LineSpacingRule

getBeforeAutoSpacing

public boolean getBeforeAutoSpacing()

Gets a value indicating whether spacing before is automatic.

Returns:

if spacing before is automatic, set to true.

setBeforeAutoSpacing

public void setBeforeAutoSpacing(boolean value)

Sets a value indicating whether spacing before is automatic.

Parameters:

value - if spacing before is automatic, set to true.

getAfterAutoSpacing

public boolean getAfterAutoSpacing()

Gets a value indicating whether spacing after is automatic.

Returns:

if spacing after is automatic, set to true.

setAfterAutoSpacing

public void setAfterAutoSpacing(boolean value)

Sets a value indicating whether spacing after is automatic.

Parameters:

value - if spacing after is automatic, set to true.

getOutlineLevel

public OutlineLevel getOutlineLevel()

Gets the outline level.

Returns:

the outline level.

setOutlineLevel

public void setOutlineLevel(OutlineLevel value)

Sets the outline level.

Parameters:

value - the outline level.

getOverflowPunc

public boolean getOverflowPunc()

Gets allow punctuation to extend past text extents.

Returns:

OverflowPunc

setOverflowPunc

public void setOverflowPunc(boolean value)

Sets allow punctuation to extend past text extents.

Parameters:

value - OverflowPunc

isFrame

public boolean isFrame()

Gets a value indicating whether this instance is frame.

Returns:

if this instance is frame, set to true.

getTextAlignment

public TextAlignment getTextAlignment()

Gets the style of textalignment

Returns:

TextAlignment

setTextAlignment

public void setTextAlignment(TextAlignment value)

Sets the style of textalignment

Parameters:

value - TextAlignment

getMirrorIndents

public boolean getMirrorIndents()

Gets a value indicating whether indentation type is mirror indents.

Returns:

is MirrorIndents or not

setMirrorIndents

public void setMirrorIndents(boolean value)

Sets a value indicating whether indentation type is mirror indents.

Parameters:

value - is MirrorIndents or not

getSuppressAutoHyphens

public boolean getSuppressAutoHyphens()

Indicates whether to suppress automatic hyphenation for the paragraph.

Returns:

is SuppressAutoHyphens or not

setSuppressAutoHyphens

public void setSuppressAutoHyphens(boolean value)

Indicates whether to suppress automatic hyphenation for the paragraph.

Parameters:

value - is SuppressAutoHyphens or not

setLeftIndentEx

public void setLeftIndentEx(float leftIndent)

Sets the value that represents the left indent for paragraph.

Parameters:

leftIndent - the left indent.

setRightIndentEx

public void setRightIndentEx(float rightIndent)

Sets the value that represents the right indent for paragraph.

Parameters:

rightIndent - the right indent.

setFirstLineIndentEx

public void setFirstLineIndentEx(float firstLineIndent)

Sets the value that represents the first line indent for paragraph.

Parameters:

firstLineIndent - The first line indent.