BaseParagraph

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.ms.System.ICloneable

public abstract class BaseParagraph implements System.ICloneable

Represents a abstract base object can be added to the page(doc.Paragraphs.Add()).

Constructors

ConstructorDescription
BaseParagraph()

Methods

MethodDescription
getVerticalAlignment()Gets a vertical alignment of paragraph
setVerticalAlignment(VerticalAlignment value)Sets a vertical alignment of paragraph
getHorizontalAlignment()Gets a horizontal alignment of paragraph
setHorizontalAlignment(HorizontalAlignment value)Sets a horizontal alignment of paragraph
getMargin()Gets a outer margin for paragraph (for pdf generation)
setMargin(MarginInfo value)Sets a outer margin for paragraph (for pdf generation)
isFirstParagraphInColumn()Gets or sets a bool value that indicates whether this paragraph will be at next column.
setFirstParagraphInColumn(boolean value)Gets or sets a bool value that indicates whether this paragraph will be at next column.
isKeptWithNext()Gets a boolean value that indicates whether current paragraph remains in the same page along with next paragraph.
setKeptWithNext(boolean value)Sets a boolean value that indicates whether current paragraph remains in the same page along with next paragraph.
isInNewPage()Gets a bool value that force this paragraph generates at new page.
setInNewPage(boolean value)Sets a boolean value that force this paragraph generates at new page.
isInLineParagraph()Gets a paragraph is inline.
setInLineParagraph(boolean value)Sets a paragraph is inline.
getHyperlink()Gets the fragment hyperlink(for pdf generator).
setHyperlink(Hyperlink value)Sets hyperlink(for pdf generator).
getZIndex()Gets an int value that indicates the Z-order of the graph.
setZIndex(int value)Sets a int value that indicates the Z-order of the graph.
deepClone()Clones this instance.

BaseParagraph()

public BaseParagraph()

getVerticalAlignment()

public VerticalAlignment getVerticalAlignment()

Gets a vertical alignment of paragraph

Returns: VerticalAlignment - VerticalAlignment element

setVerticalAlignment(VerticalAlignment value)

public void setVerticalAlignment(VerticalAlignment value)

Sets a vertical alignment of paragraph

Parameters:

ParameterTypeDescription
valueVerticalAlignmentVerticalAlignment element

getHorizontalAlignment()

public HorizontalAlignment getHorizontalAlignment()

Gets a horizontal alignment of paragraph

Returns: HorizontalAlignment - HorizontalAlignment value

setHorizontalAlignment(HorizontalAlignment value)

public void setHorizontalAlignment(HorizontalAlignment value)

Sets a horizontal alignment of paragraph

Parameters:

ParameterTypeDescription
valueHorizontalAlignmentHorizontalAlignment value

getMargin()

public MarginInfo getMargin()

Gets a outer margin for paragraph (for pdf generation)

Returns: MarginInfo - MarginInfo value

setMargin(MarginInfo value)

public void setMargin(MarginInfo value)

Sets a outer margin for paragraph (for pdf generation)

Parameters:

ParameterTypeDescription
valueMarginInfoMarginInfo object

isFirstParagraphInColumn()

public boolean isFirstParagraphInColumn()

Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)

Returns: boolean - boolean value

setFirstParagraphInColumn(boolean value)

public void setFirstParagraphInColumn(boolean value)

Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)

Parameters:

ParameterTypeDescription
valuebooleanboolean value

isKeptWithNext()

public boolean isKeptWithNext()

Gets a boolean value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)

Returns: boolean - boolean value

setKeptWithNext(boolean value)

public final void setKeptWithNext(boolean value)

Sets a boolean value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)

Parameters:

ParameterTypeDescription
valuebooleanboolean value

isInNewPage()

public boolean isInNewPage()

Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)

Returns: boolean - boolean value

setInNewPage(boolean value)

public void setInNewPage(boolean value)

Sets a boolean value that force this paragraph generates at new page. Default is false.(for pdf generation)

Parameters:

ParameterTypeDescription
valuebooleanboolean value

isInLineParagraph()

public boolean isInLineParagraph()

Gets a paragraph is inline. Default is false.(for pdf generation)

Returns: boolean - boolean value

setInLineParagraph(boolean value)

public void setInLineParagraph(boolean value)

Sets a paragraph is inline. Default is false.(for pdf generation)

Parameters:

ParameterTypeDescription
valuebooleanboolean value
public Hyperlink getHyperlink()

Gets the fragment hyperlink(for pdf generator).

Returns: Hyperlink - the fragment hyperlink(for pdf generator).

public void setHyperlink(Hyperlink value)

Sets hyperlink(for pdf generator).

Parameters:

ParameterTypeDescription
valueHyperlinkhyperlink(for pdf generator).

getZIndex()

public int getZIndex()

Gets an int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page.

Returns: int - int value

setZIndex(int value)

public void setZIndex(int value)

Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page.

Parameters:

ParameterTypeDescription
valueintint value

deepClone()

public Object deepClone()

Clones this instance. Virtual method. Always return null.

Returns: java.lang.Object - Null