paragraph-ag凯发旗舰厅

com.spire.doc.documents
class paragraph

java.lang.object
  com.spire.doc.ownerholder
      com.spire.doc.documents.xml.documentserializable
          com.spire.doc.documentobject
              com.spire.doc.documentbase
                  com.spire.doc.bodyregion
                      com.spire.doc.documents.paragraph

all implemented interfaces:

ibodyregion, irunattrsource, icompositeobject, idocumentobject, iparagraph, istyleholder

public class paragraph
extends bodyregion
implements iparagraph, icompositeobject, irunattrsource

represents a paragraph of text.

paragraph

public paragraph(idocument doc)

initializes a new instance of the paragraph class.

parameters:

doc - doc

getlisttext

public java.lang.string getlisttext()

gets the list text.

returns:

string

getdocumentobjecttype

public documentobjecttype getdocumentobjecttype()

gets the type of the document object.

specified by:

getdocumentobjecttype in interface idocumentobject

specified by:

getdocumentobjecttype in class documentobject

returns:

documentobjecttype

getchildobjects

public documentobjectcollection getchildobjects()

gets the child objects.

specified by:

getchildobjects in interface icompositeobject

specified by:

getchildobjects in class documentobject

returns:

the child objects.

getstylename

public java.lang.string getstylename()

gets paragraph style name.

specified by:

getstylename in interface istyleholder

returns:

string

gettext

public java.lang.string gettext()

returns paragraph text.

specified by:

gettext in interface iparagraph

returns:

string

settext

public void settext(java.lang.string value)

sets paragraph text. all internal formatting will be cleared when new text is set.

specified by:

settext in interface iparagraph

parameters:

value - string

get

public paragraphbase get(int index)

gets paragraph item by index.

specified by:

get in interface iparagraph

parameters:

index - index

returns:

paragraphbase

getitems

public paragraphitemcollection getitems()

gets paragraph items.

specified by:

getitems in interface iparagraph

returns:

the items.

getformat

public paragraphformat getformat()

gets paragraph format.

specified by:

getformat in interface iparagraph

returns:

paragraphformat

getbreakcharacterformat

public characterformat getbreakcharacterformat()

gets character format for the break symbol.

specified by:

getbreakcharacterformat in interface iparagraph

returns:

characterformat

getlistformat

public listformat getlistformat()

gets format of the list for the paragraph.

specified by:

getlistformat in interface iparagraph

returns:

listformat

isincell

public boolean isincell()

gets a value indicating whether this paragraph is in cell.

specified by:

isincell in interface iparagraph

returns:

if this paragraph is in cell, set to true.

isendofsection

public boolean isendofsection()

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

specified by:

isendofsection in interface iparagraph

returns:

if this paragraph is end of section, set to true

isendofdocument

public boolean isendofdocument()

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

specified by:

isendofdocument in interface iparagraph

returns:

if this instance is end of document, set to true

getwordcount

public int getwordcount()

gets the word count.

returns:

int

getcharcount

public int getcharcount()

gets the char count,whtout spaces.

returns:

int

getcharcountincludespace

public int getcharcountincludespace()

gets the char count of the include spaces.

returns:

int

applystyle

public void applystyle(java.lang.string stylename)

applies the specified style. specified style must exist in document.styles collection

specified by:

applystyle in interface istyleholder

parameters:

stylename - style name

applystyle

public void applystyle(builtinstyle builtinstyle)

applies the built-in style.

specified by:

applystyle in interface istyleholder

parameters:

builtinstyle - the built-in style.

getstyle

public paragraphstyle getstyle()

gets related style.

specified by:

getstyle in interface iparagraph

returns:

the paragraphstyle

removeabsposition

public void removeabsposition()

removes the absolute position data. if paragraph has absolute position in the document, all position data will be erased.

specified by:

removeabsposition in interface iparagraph

appendtext

public textrange appendtext(java.lang.string text)

appends text to end of document.

specified by:

appendtext in interface iparagraph

parameters:

text - string

returns:

textrange

appendpicture

public docpicture appendpicture(byte[] imagebytes)

appends image to end of paragraph.

specified by:

appendpicture in interface iparagraph

parameters:

imagebytes - imagebytes

returns:

docpicture

appendfield

public field appendfield(java.lang.string fieldname,
                         fieldtype fieldtype)

appends the field.

specified by:

appendfield in interface iparagraph

parameters:

fieldname - fieldname

fieldtype - fieldtype

returns:

field

appendfieldmark

public fieldmark appendfieldmark(fieldmarktype type)

appends the field mark.

parameters:

type - the type.

returns:

fieldmark

appendhyperlink

public field appendhyperlink(java.lang.string link,
                             java.lang.string text,
                             hyperlinktype type)

appends the hyperlink.

specified by:

appendhyperlink in interface iparagraph

parameters:

link - the link.

text - the text to display.

type - the hyperlink type.

returns:

field

appendhyperlink

public field appendhyperlink(java.lang.string link,
                             docpicture picture,
                             hyperlinktype type)

appends the hyperlink.

specified by:

appendhyperlink in interface iparagraph

parameters:

link - the link.

picture - the picture to display.

type - the type of hyperlink.

returns:

field

appendbookmarkstart

public bookmarkstart appendbookmarkstart(java.lang.string name)

appends start of the bookmark with specified name into paragraph.

specified by:

appendbookmarkstart in interface iparagraph

parameters:

name - name

returns:

bookmarkstart

appendbookmarkend

public bookmarkend appendbookmarkend(java.lang.string name)

appends end of the bookmark with specified name into paragraph.

specified by:

appendbookmarkend in interface iparagraph

parameters:

name - name

returns:

bookmarkend

appendpermstart

public permissionstart appendpermstart(java.lang.string id)

appends start of the permission with specified id into paragraph.

parameters:

id - id

returns:

permissionstart

appendpermend

public permissionend appendpermend(java.lang.string id)

appends end of the permission with specified id into paragraph.

parameters:

id - id

returns:

permissionend

appendcomment

public comment appendcomment(java.lang.string text)

appends the comment.

specified by:

appendcomment in interface iparagraph

parameters:

text - the string.

returns:

returns wcomment.

appendcommentmark

public commentmark appendcommentmark(commentmarktype type)

appends the comment mark.

parameters:

type - the type.

returns:

returns commentmark.

appendfootnote

public footnote appendfootnote(footnotetype type)

appends the footnote.

specified by:

appendfootnote in interface iparagraph

parameters:

type - the type.

returns:

returns the footnotes.

appendfootnote

public footnote appendfootnote(footnotetype type,
                               boolean bisautonumbered)

appends the footnote.

parameters:

type - the type.

bisautonumbered - is auto numbered.

returns:

footnote

appendtextbox

public textbox appendtextbox(float width,
                             float height)

append textbox to the end of the paragraph

specified by:

appendtextbox in interface iparagraph

parameters:

width - textbox width

height - textbox height

returns:

textbox

appendcheckbox

public checkboxformfield appendcheckbox()

appends the check box form field.

specified by:

appendcheckbox in interface iparagraph

returns:

checkboxformfield

appendcheckbox

public checkboxformfield appendcheckbox(java.lang.string checkboxname,
                                        boolean defaultcheckboxvalue)

appends the check box.

specified by:

appendcheckbox in interface iparagraph

parameters:

checkboxname - name of the check box.

defaultcheckboxvalue - default checkbox value

returns:

checkboxformfield

appendtextformfield

public textformfield appendtextformfield(java.lang.string defaulttext)

appends the text form field.

specified by:

appendtextformfield in interface iparagraph

parameters:

defaulttext - the default text. pass "null" to insert default word text

returns:

textformfield

appendtextformfield

public textformfield appendtextformfield(java.lang.string formfieldname,
                                         java.lang.string defaulttext)

appends the text form field.

specified by:

appendtextformfield in interface iparagraph

parameters:

formfieldname - name of the form field.

defaulttext - the default text. pass "null" to insert default word text

returns:

textformfield

appenddropdownformfield

public dropdownformfield appenddropdownformfield()

appends the drop down form field.

specified by:

appenddropdownformfield in interface iparagraph

returns:

dropdownformfield

appenddropdownformfield

public dropdownformfield appenddropdownformfield(java.lang.string dropdropdownname)

appends the drop down form field.

specified by:

appenddropdownformfield in interface iparagraph

parameters:

dropdropdownname - name of the drop drop down.

returns:

dropdownformfield

appendsymbol

public symbol appendsymbol(byte charactercode)

appends special symbol to end of paragraph.

specified by:

appendsymbol in interface iparagraph

parameters:

charactercode - the character code.

returns:

symbol

appendshape

public shapeobject appendshape(float width,
                               float height,
                               shapetype shapetype)

append shape to the end of the paragraph.

parameters:

width - shape width

height - shape height

shapetype - shape type

returns:

shapeobject

appendshapegroup

public shapegroup appendshapegroup(float width,
                                   float height)

append shape group to the end of the paragraph.

parameters:

width - the width.

height - the height.

returns:

shapegroup

appendbreak

public break appendbreak(breaktype breaktype)

appends break to end of paragraph.

specified by:

appendbreak in interface iparagraph

parameters:

breaktype - the break type.

returns:

break

appendtoc

public tableofcontent appendtoc(int lowerlevel,
                                int upperlevel)

appends the table of content.

specified by:

appendtoc in interface iparagraph

parameters:

lowerlevel - the starting heading level of the table of content.

upperlevel - the ending heading level of the table of content.

returns:

tableofcontent

appendoleobject

public docoleobject appendoleobject(java.io.inputstream olestream,
                                    docpicture olepicture,
                                    oleobjecttype type)

appends the ole object.

specified by:

appendoleobject in interface iparagraph

parameters:

olestream - the ole object (file) stream.

olepicture - the ole picture.

type - the type of ole object.

returns:

docoleobject

appendpicture

public docpicture appendpicture(java.io.inputstream inputstream)

appends the picture

specified by:

appendpicture in interface iparagraph

parameters:

inputstream - the image input stream

returns:

docpicture

appendpicture

public docpicture appendpicture(java.lang.string filepath)

appends the picture

specified by:

appendpicture in interface iparagraph

parameters:

filepath - the image file path

returns:

docpicture

appendhtml

public void appendhtml(java.lang.string html)

appends the html.

specified by:

appendhtml in interface iparagraph

parameters:

html - the html.

appendrtf

public void appendrtf(java.lang.string rtfcode,
                      boolean addtolastsection)

appends the rtf.

parameters:

rtfcode - the rtf code.

addtolastsection - when is true, added to the last section of the document.

appendrtf

public void appendrtf(java.lang.string rtfcode)

appends the rtf.

parameters:

rtfcode - the rtf code.

appendoleobject

public docoleobject appendoleobject(byte[] olebytes,
                                    docpicture olepicture,
                                    oleobjecttype type)

appends the ole object into paragraph.

specified by:

appendoleobject in interface iparagraph

parameters:

olebytes - the ole object (file) bytes.

olepicture - the ole picture.

type - the type of ole object.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(java.lang.string pathtofile,
                                    docpicture olepicture,
                                    oleobjecttype type)

appends the ole object into paragraph.

specified by:

appendoleobject in interface iparagraph

parameters:

pathtofile - the path to file.

olepicture - the ole picture.

type - the type of ole object.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(java.lang.string pathtofile,
                                    docpicture olepicture)

appends the ole object.

specified by:

appendoleobject in interface iparagraph

parameters:

pathtofile - the path to file.

olepicture - the ole picture.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(java.io.inputstream olestream,
                                    docpicture olepicture,
                                    olelinktype olelinktype)

appends the ole object into paragraph.

specified by:

appendoleobject in interface iparagraph

parameters:

olestream - the ole storage.

olepicture - the ole picture.

olelinktype - the type of ole object link type.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(byte[] olebytes,
                                    docpicture olepicture,
                                    olelinktype olelinktype)

appends the ole object.

specified by:

appendoleobject in interface iparagraph

parameters:

olebytes - the ole storage bytes.

olepicture - the ole picture.

olelinktype - type of the ole link.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(java.lang.string linkfile,
                                    docpicture olepicture,
                                    olelinktype olelinktype)

appends the ole object.

parameters:

linkfile - the link file.

olepicture - the ole picture.

olelinktype - type of the ole link.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(byte[] olebytes,
                                    docpicture olepicture,
                                    java.lang.string fileextension)

appends the openpackage ole object (ole object without specified type).

specified by:

appendoleobject in interface iparagraph

parameters:

olebytes - the ole object bytes.

olepicture - the ole picture.

fileextension - the file extension.

returns:

docoleobject

appendoleobject

public docoleobject appendoleobject(java.io.inputstream olestream,
                                    docpicture olepicture,
                                    java.lang.string fileextension)

appends the openpackage ole object (ole object without specified type).

specified by:

appendoleobject in interface iparagraph

parameters:

olestream - the ole file stream.

olepicture - the ole picture.

fileextension - the file extension.

returns:

docoleobject

removeframe

public void removeframe()

remove a frame.

find

public textselection find(java.util.regex.pattern pattern)

returns first entry of matchstring regex.

specified by:

find in class bodyregion

parameters:

pattern - the pattern.

returns:

textselection

find

public textselection find(java.lang.string given,
                          boolean casesensitive,
                          boolean wholeword)

returns first entry of matchstring string, taking into consideration casesensitive and wholeword options.

parameters:

given - the matchstring.

casesensitive - if it is case sensitive, set to true

wholeword - if it specifies to search a whole word, set to true

returns:

textselection

replace

public int replace(java.util.regex.pattern pattern,
                   java.lang.string replace)

replaces all entries of matchstring regular expression with newvalue string.

specified by:

replace in interface ibodyregion

specified by:

replace in class bodyregion

parameters:

pattern - the pattern.

replace - the newvalue.

returns:

int

replace

public int replace(java.lang.string given,
                   java.lang.string replace,
                   boolean casesensitive,
                   boolean wholeword)

replaces all entries of matchstring string with newvalue string, taking into consideration casesensitive and wholeword options.

specified by:

replace in interface ibodyregion

specified by:

replace in class bodyregion

parameters:

given - the matchstring text to newvalue

replace - the newvalue text .

casesensitive - if specifies case sensitive, set to true

wholeword - if it specifies to search a whole word, set to true

returns:

int

replace

public int replace(java.util.regex.pattern pattern,
                   textselection textselection)

replaces all entries of matchstring regular expression with textrangesholder.

specified by:

replace in interface ibodyregion

specified by:

replace in class bodyregion

parameters:

pattern - the pattern.

textselection - the text selection.

returns:

int

replace

public int replace(java.util.regex.pattern pattern,
                   textselection textselection,
                   boolean saveformatting)

replaces all entries of matchstring regular expression with textrangesholder.

specified by:

replace in class bodyregion

parameters:

pattern - the pattern.

textselection - the text selection.

saveformatting - if it specifies save source formatting, set to true

returns:

int

replace

public 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.

specified by:

replace in interface iparagraph

parameters:

given - the matchstring.

textselection - the text selection.

casesensitive - if it specifies case sensitive, set to true

wholeword - if it specifies to check whole word, set to true

returns:

int

replace

public int replace(java.lang.string given,
                   textselection textselection,
                   boolean casesensitive,
                   boolean wholeword,
                   boolean saveformatting)

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, set to true

wholeword - if it specifies to search a whole word, set to true

saveformatting - if it specifies save source formatting, set to true

returns:

int

insertsectionbreak

public section insertsectionbreak()

inserts the section break.

returns:

section

insertsectionbreak

public section insertsectionbreak(sectionbreaktype breaktype)

inserts the section break.

parameters:

breaktype - type of the break.

returns:

section

updatewordcount

public void updatewordcount(char[] splitchar,
                            boolean includetb)

calculate word count and character count of the paragraph.

parameters:

splitchar - splitchar

includetb - includetb

updatelistvalue

public java.lang.string updatelistvalue()

updates the list value.

returns:

the value string.

getlistformatforapplystyle

public listformat getlistformatforapplystyle()

gets the list format for apply style.

returns:

the list format

getdirectrunattr

public java.lang.object getdirectrunattr(int key)

description copied from interface: irunattrsource

gets the attribute specified directly on the source or null by the key.

specified by:

getdirectrunattr in interface irunattrsource

parameters:

key - key

returns:

object

getdirectrunattrscount

public int getdirectrunattrscount()

description copied from interface: irunattrsource

count of attribute records in direct formatting.

specified by:

getdirectrunattrscount in interface irunattrsource

returns:

int

getdirectrunattrbyindex

public void getdirectrunattrbyindex(int index,
                                    int[] key,
                                    java.lang.object[] value)

description copied from interface: irunattrsource

gets the attribute specified directly on the source by the index. index should be in range [0 .. directrunattrscount - 1]

specified by:

getdirectrunattrbyindex in interface irunattrsource

parameters:

index - int

key - leys

value - objects

fetchinheritedrunattr

public java.lang.object fetchinheritedrunattr(int key)

description copied from interface: irunattrsource

gets the attribute from one of the parents or from global defaults. throws if the attribute is not defined anywhere. if the attribute needs resolution, it is returned resolved.

specified by:

fetchinheritedrunattr in interface irunattrsource

parameters:

key - key

returns:

object

setrunattr

public void setrunattr(int key,
                       java.lang.object value)

description copied from interface: irunattrsource

sets run attribute.

specified by:

setrunattr in interface irunattrsource

parameters:

key - key

value - object

clearrunattrs

public void clearrunattrs()

description copied from interface: irunattrsource

clears run attributes.

specified by:

clearrunattrs in interface irunattrsource