com.spire.doc.interfaces
Interface IParagraph

All Superinterfaces:

IBodyRegion, IDocumentObject, IStyleHolder

All Known Implementing Classes:

Paragraph

public interface IParagraph
extends IBodyRegion, IStyleHolder

Represents a paragraph inside a Section.

Method Summary

BookmarkEnd	appendBookmarkEnd(java.lang.String name) Appends end of the bookmark with specified name into paragraph.
BookmarkStart	appendBookmarkStart(java.lang.String name) Appends start of the bookmark with specified name into paragraph.
Break	appendBreak(BreakType breakType) Appends break to end of paragraph.
CheckBoxFormField	appendCheckBox() Appends the check box.
CheckBoxFormField	appendCheckBox(java.lang.String checkBoxName, boolean defaultCheckBoxValue) Appends the check box.
Comment	appendComment(java.lang.String text) Appends the comment.
DropDownFormField	appendDropDownFormField() Appends the drop down form field.
DropDownFormField	appendDropDownFormField(java.lang.String dropDropDownName) Appends the drop down form field.
Field	appendField(java.lang.String fieldName, FieldType fieldType) Appends field to the end of paragraph
Footnote	appendFootnote(FootnoteType type) Appends the footnote.
void	appendHTML(java.lang.String html) Appends the HTML.
Field	appendHyperlink(java.lang.String link, DocPicture picture, HyperlinkType type) Appends the hyperlink.
Field	appendHyperlink(java.lang.String link, java.lang.String text, HyperlinkType type) Appends the hyperlink.
DocOleObject	appendOleObject(byte[] oleBytes, DocPicture olePicture, OleLinkType oleLinkType) Appends the OLE object.
DocOleObject	appendOleObject(byte[] oleBytes, DocPicture olePicture, OleObjectType type) Appends the OLE object.
DocOleObject	appendOleObject(byte[] oleBytes, DocPicture olePicture, java.lang.String fileExtension) Appends the openpackage OLE object (ole object without specified type).
DocOleObject	appendOleObject(java.io.InputStream stream, DocPicture pic, OleLinkType oleLinkType) Appends the OLE object into paragraph.
DocOleObject	appendOleObject(java.io.InputStream oleStream, DocPicture olePicture, OleObjectType type) Appends the OLE object.
DocOleObject	appendOleObject(java.io.InputStream oleStream, DocPicture olePicture, java.lang.String fileExtension) Appends the openpackage OLE object (ole object without specified type).
DocOleObject	appendOleObject(java.lang.String pathToFile, DocPicture olePicture) Appends the OLE object.
DocOleObject	appendOleObject(java.lang.String pathToFile, DocPicture olePicture, OleObjectType type) Appends the OLE object.
DocPicture	appendPicture(byte[] imageBytes) Appends picture to the end of paragraph.
DocPicture	appendPicture(java.io.InputStream inputStream) Appends picture to the end of paragraph.
DocPicture	appendPicture(java.lang.String filePath) Appends picture to the end of paragraph.
Symbol	appendSymbol(byte characterCode) Appends symbol to the end of paragraph.
TextRange	appendText(java.lang.String text) Appends text to the end of paragraph.
TextBox	appendTextBox(float width, float height) Appends textbox to the end of the paragraph
TextFormField	appendTextFormField(java.lang.String defaultText) Appends the text form field.
TextFormField	appendTextFormField(java.lang.String formFieldName, java.lang.String defaultText) Appends the text form field.
TableOfContent	appendTOC(int lowerHeadingLevel, int upperHeadingLevel) Appends the TOC.
ParagraphBase	get(int index) Gets the ParagraphBase at the specified index.
CharacterFormat	getBreakCharacterFormat() Gets the character format for the break symbol.
ParagraphFormat	getFormat() Gets the paragraph format.
ParagraphItemCollection	getItems() Gets the paragraph items.
ListFormat	getListFormat() Gets list formatting for the paragraph.
ParagraphStyle	getStyle() Gets related style.
java.lang.String	getText() Returns paragraph text.
boolean	isEndOfDocument() Gets a value indicating whether this paragraph is end of document.
boolean	isEndOfSection() Gets a value indicating whether this paragraph is end of section.
boolean	isInCell() Gets a value indicating whether this paragraph is in cell.
void	removeAbsPosition() Removes the absolute position data.
int	replace(java.lang.String given, TextSelection textSelection, boolean caseSensitive, boolean wholeWord) Replaces all entries of matchString string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.
void	setText(java.lang.String value) Sets paragraph text.

Methods inherited from interface com.spire.doc.documents.IBodyRegion

replace, replace, replace

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getDocumentObjectType, getNextSibling, getOwner, getPreviousSibling, isComposite

Methods inherited from interface com.spire.doc.interfaces.IStyleHolder

applyStyle, applyStyle, getStyleName

Method Detail

getText

java.lang.String getText()

Returns paragraph text.

Returns:

text

setText

void setText(java.lang.String value)

Sets paragraph text.

Parameters:

value - value

get

ParagraphBase get(int index)

Gets the ParagraphBase at the specified index.

Parameters:

index - index

Returns:

ParagraphBase

getItems

ParagraphItemCollection getItems()

Gets the paragraph items.

Returns:

The items.

getFormat

ParagraphFormat getFormat()

Gets the paragraph format.

Returns:

ParagraphFormat

getListFormat

ListFormat getListFormat()

Gets list formatting for the paragraph.

Returns:

ListFormat

getBreakCharacterFormat

CharacterFormat getBreakCharacterFormat()

Gets the character format for the break symbol.

Returns:

CharacterFormat

isInCell

boolean isInCell()

Gets a value indicating whether this paragraph is in cell.

Returns:

if this paragraph is in cell, set to true.

isEndOfSection

boolean isEndOfSection()

Gets a value indicating whether this paragraph is end of section.

Returns:

if this paragraph is end of section, set to true.

isEndOfDocument

boolean isEndOfDocument()

Gets a value indicating whether this paragraph is end of document.

Returns:

if this instance is end of document, set to true.

appendText

TextRange appendText(java.lang.String text)

Appends text to the end of paragraph.

Parameters:

text - the text.

Returns:

TextRange

appendPicture

DocPicture appendPicture(java.io.InputStream inputStream)

Appends picture to the end of paragraph.

Parameters:

inputStream - the file input stream

Returns:

DocPicture

appendPicture

DocPicture appendPicture(java.lang.String filePath)

Appends picture to the end of paragraph.

Parameters:

filePath - the file path

Returns:

DocPicture

appendPicture

DocPicture appendPicture(byte[] imageBytes)

Appends picture to the end of paragraph.

Parameters:

imageBytes - the image bytes.

Returns:

DocPicture

appendField

Field appendField(java.lang.String fieldName,
                  FieldType fieldType)

Appends field to the end of paragraph

Parameters:

fieldName - name of the field.

fieldType - type of the field.

Returns:

Field

appendBookmarkStart

BookmarkStart appendBookmarkStart(java.lang.String name)

Appends start of the bookmark with specified name into paragraph.

Parameters:

name - the name.

Returns:

BookmarkStart

appendBookmarkEnd

BookmarkEnd appendBookmarkEnd(java.lang.String name)

Appends end of the bookmark with specified name into paragraph.

Parameters:

name - the name.

Returns:

BookmarkEnd

appendComment

Comment appendComment(java.lang.String text)

Appends the comment.

Parameters:

text - text

Returns:

Comment

appendFootnote

Footnote appendFootnote(FootnoteType type)

Appends the footnote.

Parameters:

type - the type.

Returns:

Footnote

appendTextBox

TextBox appendTextBox(float width,
                      float height)

Appends textbox to the end of the paragraph

Parameters:

width - textbox width

height - textbox height

Returns:

TextBox

appendSymbol

Symbol appendSymbol(byte characterCode)

Appends symbol to the end of paragraph.

Parameters:

characterCode - the character code.

Returns:

Symbol

appendBreak

Break appendBreak(BreakType breakType)

Appends break to end of paragraph.

Parameters:

breakType - type of the break.

Returns:

Break

appendHTML

void appendHTML(java.lang.String html)

Appends the HTML.

Parameters:

html - the HTML.

getStyle

ParagraphStyle getStyle()

Gets related style.

Returns:

ParagraphStyle

replace

int replace(java.lang.String given,
            TextSelection textSelection,
            boolean caseSensitive,
            boolean wholeWord)

Replaces all entries of matchString string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.

Parameters:

given - the matchString.

textSelection - the text selection.

caseSensitive - if it specifies case sensitive search, set to true

wholeWord - if it specifies the whole word to be newValue, set to true.

Returns:

int value

appendCheckBox

CheckBoxFormField appendCheckBox()

Appends the check box.

Returns:

CheckBoxFormField

appendTextFormField

TextFormField appendTextFormField(java.lang.String defaultText)

Appends the text form field.

Parameters:

defaultText - the default text.

Returns:

TextFormField

appendDropDownFormField

DropDownFormField appendDropDownFormField()

Appends the drop down form field.

Returns:

DropDownFormField

appendCheckBox

CheckBoxFormField appendCheckBox(java.lang.String checkBoxName,
                                 boolean defaultCheckBoxValue)

Appends the check box.

Parameters:

checkBoxName - name of the check box.

defaultCheckBoxValue - default checkbox value.

Returns:

CheckBoxFormField

appendTextFormField

TextFormField appendTextFormField(java.lang.String formFieldName,
                                  java.lang.String defaultText)

Appends the text form field.

Parameters:

formFieldName - name of the form field.

defaultText - the default text.

Returns:

TextFormField

appendDropDownFormField

DropDownFormField appendDropDownFormField(java.lang.String dropDropDownName)

Appends the drop down form field.

Parameters:

dropDropDownName - name of the drop drop down

Returns:

DropDownFormField

appendHyperlink

Field appendHyperlink(java.lang.String link,
                      java.lang.String text,
                      HyperlinkType type)

Appends the hyperlink.

Parameters:

link - the link.

text - the text to display.

type - the hyperlink type.

Returns:

Field

appendHyperlink

Field appendHyperlink(java.lang.String link,
                      DocPicture picture,
                      HyperlinkType type)

Appends the hyperlink.

Parameters:

link - the link.

picture - the picture to display.

type - the type of hyperlink.

Returns:

Field

removeAbsPosition

void removeAbsPosition()

Removes the absolute position data. If paragraph has absolute position in the document, all position data will be erased.

appendTOC

TableOfContent appendTOC(int lowerHeadingLevel,
                         int upperHeadingLevel)

Appends the TOC.

Parameters:

lowerHeadingLevel - the lower heading level.

upperHeadingLevel - the upper heading level.

Returns:

TableOfContent

appendOleObject

DocOleObject appendOleObject(java.io.InputStream oleStream,
                             DocPicture olePicture,
                             OleObjectType type)

Appends the OLE object.

Parameters:

oleStream - the OLE stream.

olePicture - the OLE picture.

type - type

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(byte[] oleBytes,
                             DocPicture olePicture,
                             OleObjectType type)

Appends the OLE object.

Parameters:

oleBytes - the OLE bytes.

olePicture - the OLE picture.

type - type

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(java.lang.String pathToFile,
                             DocPicture olePicture,
                             OleObjectType type)

Appends the OLE object.

Parameters:

pathToFile - the path to file.

olePicture - the OLE picture.

type - type of the OLE object file

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(java.lang.String pathToFile,
                             DocPicture olePicture)

Appends the OLE object.

Parameters:

pathToFile - the path to file.

olePicture - the OLE picture.

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(java.io.InputStream stream,
                             DocPicture pic,
                             OleLinkType oleLinkType)

Appends the OLE object into paragraph.

Parameters:

stream - the OLE storage.

pic - the OLE picture.

oleLinkType - the type of OLE object link type.

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(byte[] oleBytes,
                             DocPicture olePicture,
                             OleLinkType oleLinkType)

Appends the OLE object.

Parameters:

oleBytes - the OLE storage bytes.

olePicture - the OLE picture.

oleLinkType - type of the OLE link.

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(byte[] oleBytes,
                             DocPicture olePicture,
                             java.lang.String fileExtension)

Appends the openpackage OLE object (ole object without specified type).

Parameters:

oleBytes - the OLE object bytes.

olePicture - the OLE picture.

fileExtension - the file extension.

Returns:

DocOleObject

appendOleObject

DocOleObject appendOleObject(java.io.InputStream oleStream,
                             DocPicture olePicture,
                             java.lang.String fileExtension)

Appends the openpackage OLE object (ole object without specified type).

Parameters:

oleStream - the OLE file stream.

olePicture - the OLE picture

fileExtension - the file extension.

Returns:

DocOleObject