itextframeproperties-ag凯发旗舰厅

overview  package   class  tree  deprecated  index  help 
 prev class   next class frames    no frames    
summary: nested | field | constr | method detail: field | constr | method

com.spire.presentation
interface itextframeproperties

public interface itextframeproperties
method summary
 void dispose()
          dispose object and free resources.
 textanchortype getanchoringtype()
          gets vertical anchor text in a textframe.
 textautofittype getautofittype()
          gets text's autofit mode.
 double getmarginbottom()
          gets the bottom margin (points) in a textframe.
 double getmarginleft()
          gets the left margin (points) in a textframe.
 double getmarginright()
          gets the right margin (points) in a textframe.
 double getmargintop()
          gets the top margin (points) in a textframe.
 float getmaxwidth()
           
 paragraphcollection getparagraphs()
          gets the list of all paragraphs in a frame.
 java.lang.object getparent()
          reference to parent object.
 presentation getpresentation()
           
 boolean getrighttoleftcolumns()
          get columns style right to left.
 float getrotationangle()
          gets the rotation angle of text frame .
 activeslide getslide()
          gets the parent slide of a textframe.
 java.awt.geom.point2d getstartlocationatmaxwidth()
           
 java.lang.string gettext()
          gets the plain text for a textframe.
 java.awt.geom.point2d gettextlocation()
           
 portionex gettextrange()
          text range of text frame.
 textstyle gettextstyle()
          gets text's style.
 textparagraphproperties[] gettextstylecache()
          gets text's style combine with parent.
 formatthreed gettextthreed()
          gets the formatthreed object that 3d effect properties for text.
 verticaltexttype getverticaltexttype()
          indicates text orientation.
 boolean getwordwrap()
          true if text is wrapped at textframe's margins.
 void highlighttext(java.lang.string text, java.awt.color color, texthighlightingoptions options)
          highlight all matches of sample in text frame text using specified color.
 boolean iscentered()
          indicates, whether text should be centered in box horizontally.
 void iscentered(boolean value)
           
 void setanchoringtype(textanchortype value)
          sets vertical anchor text in a textframe.
 void setautofittype(textautofittype value)
          sets text's autofit mode.
 void setmarginbottom(double value)
          sets the bottom margin (points) in a textframe.
 void setmarginleft(double value)
          sets the left margin (points) in a textframe.
 void setmarginright(double value)
          sets the right margin (points) in a textframe.
 void setmargintop(double value)
          sets the top margin (points) in a textframe.
 void setrighttoleftcolumns(boolean righttoleftcolumns)
          set columns style right to left.
 void setrotationangle(float value)
          sets the rotation angle of text frame .
 void settext(java.lang.string value)
          sets the plain text for a textframe.
 void setverticaltexttype(verticaltexttype value)
           
 void setwordwrap(boolean value)
           
 
method detail

getparagraphs

paragraphcollection getparagraphs()
gets the list of all paragraphs in a frame. read-only .
returns:

gettext

java.lang.string gettext()
gets the plain text for a textframe.
returns:
the text.

settext

void settext(java.lang.string value)
             throws documenteditexception
sets the plain text for a textframe.
throws:
documenteditexception

gettextstyle

textstyle gettextstyle()
gets text's style. readonly .
returns:

gettextstylecache

textparagraphproperties[] gettextstylecache()
gets text's style combine with parent.
returns:

getmarginleft

double getmarginleft()
gets the left margin (points) in a textframe. read/write .
returns:

setmarginleft

void setmarginleft(double value)
                   throws appexception
sets the left margin (points) in a textframe. read/write .
throws:
appexception

getmarginright

double getmarginright()
gets the right margin (points) in a textframe. read/write .
returns:

setmarginright

void setmarginright(double value)
                    throws appexception
sets the right margin (points) in a textframe. read/write .
throws:
appexception

getmargintop

double getmargintop()
gets the top margin (points) in a textframe. read/write .
returns:

setmargintop

void setmargintop(double value)
                  throws appexception
sets the top margin (points) in a textframe. read/write .
throws:
appexception

getmarginbottom

double getmarginbottom()
gets the bottom margin (points) in a textframe. read/write .
returns:

setmarginbottom

void setmarginbottom(double value)
                     throws appexception
sets the bottom margin (points) in a textframe. read/write .
throws:
appexception

gettextrange

portionex gettextrange()
text range of text frame.
returns:

getwordwrap

boolean getwordwrap()
true if text is wrapped at textframe's margins. read/write .
returns:

setwordwrap

void setwordwrap(boolean value)

getanchoringtype

textanchortype getanchoringtype()
gets vertical anchor text in a textframe. read/write .
returns:

setanchoringtype

void setanchoringtype(textanchortype value)
sets vertical anchor text in a textframe. read/write .

iscentered

boolean iscentered()
indicates, whether text should be centered in box horizontally. read/write .
returns:

iscentered

void iscentered(boolean value)

getverticaltexttype

verticaltexttype getverticaltexttype()
indicates text orientation. read/write .
returns:

setverticaltexttype

void setverticaltexttype(verticaltexttype value)

getautofittype

textautofittype getautofittype()
gets text's autofit mode. read/write .
returns:

setautofittype

void setautofittype(textautofittype value)
sets text's autofit mode. read/write .

getslide

activeslide getslide()
gets the parent slide of a textframe. read-only .
returns:
throws:
java.lang.exception

getpresentation

presentation getpresentation()

getparent

java.lang.object getparent()
reference to parent object. read-only.
returns:

dispose

void dispose()
dispose object and free resources.

gettextthreed

formatthreed gettextthreed()
gets the formatthreed object that 3d effect properties for text.
returns:
3d effect properties for text.

getrotationangle

float getrotationangle()
gets the rotation angle of text frame .
returns:

setrotationangle

void setrotationangle(float value)
sets the rotation angle of text frame .

highlighttext

void highlighttext(java.lang.string text,
                   java.awt.color color,
                   texthighlightingoptions options)
highlight all matches of sample in text frame text using specified color.
parameters:
text - : text sample to highlight.
color - : highlighting color.
options - : highlighting options.

getrighttoleftcolumns

boolean getrighttoleftcolumns()
get columns style right to left.
returns:

setrighttoleftcolumns

void setrighttoleftcolumns(boolean righttoleftcolumns)
set columns style right to left.
parameters:
righttoleftcolumns -

gettextlocation

java.awt.geom.point2d gettextlocation()
returns:
the location in slide.

getmaxwidth

float getmaxwidth()
returns:
the max width.

getstartlocationatmaxwidth

java.awt.geom.point2d getstartlocationatmaxwidth()
returns:
the coordinate in shape when the width reaches the maximum.
overview  package   class  tree  deprecated  index  help 
 prev class   next class frames    no frames    
summary: nested | field | constr | method detail: field | constr | method
网站地图