listlevel-ag凯发旗舰厅

com.spire.doc.documents
class listlevel

java.lang.object
  com.spire.doc.ownerholder
      com.spire.doc.documents.xml.documentserializable
          com.spire.doc.documents.listlevel

public class listlevel
extends documentserializable

summary description for wlistlevel.

listlevel

public listlevel(liststyle liststyle)

initializes a new instance of the listlevel class

parameters:

liststyle -

getnumberalignment

public listnumberalignment getnumberalignment()

get alignment (left, right, or centered) of the paragraph number.

returns:

listnumberalignment

setnumberalignment

public void setnumberalignment(listnumberalignment value)

set alignment (left, right, or centered) of the paragraph number.

parameters:

value - listnumberalignment

getstartat

public int getstartat()

get start at value.

returns:

int

setstartat

public void setstartat(int value)

set start at value.

parameters:

value - int

gettabspaceafter

public float gettabspaceafter()

get spacing after list level's number or bullet ( tab position if follow character is tab ).

returns:

float

settabspaceafter

public void settabspaceafter(float value)

set spacing after list level's number or bullet ( tab position if follow character is tab ).

parameters:

value - float

gettextposition

public float gettextposition()

returns listlevel indent

returns:

float

settextposition

public void settextposition(float value)

setsleft listlevel indent

parameters:

value - float

getnumberprefix

public java.lang.string getnumberprefix()

get prefix pattern for numbered level.

returns:

string

setnumberprefix

public void setnumberprefix(java.lang.string value)

set prefix pattern for numbered level.

parameters:

value - string

getnumbersufix

public java.lang.string getnumbersufix()

returns suffix pattern for numbered level.

returns:

the numbersubffix

setnumbersufix

public void setnumbersufix(java.lang.string value)

sets suffix pattern for numbered level.

parameters:

value - string

getbulletcharacter

public java.lang.string getbulletcharacter()

get bullet pattern

returns:

string

setbulletcharacter

public void setbulletcharacter(java.lang.string value)

set bullet pattern

parameters:

value -

getpatterntype

public listpatterntype getpatterntype()

returns list numbering type.

returns:

listpatterntype

setpatterntype

public void setpatterntype(listpatterntype value)

sets list numbering type.

parameters:

value - listpatterntype

getnorestartbyhigher

public boolean getnorestartbyhigher()

true if the level's number sequence is not restarted by higher (more significant) levels in the list.

returns:

boolean

setnorestartbyhigher

public void setnorestartbyhigher(boolean value)

true if the level's number sequence is not restarted by higher (more significant) levels in the list.

parameters:

value - boolean

getcharacterformat

public characterformat getcharacterformat()

returns character formats of list symbol.

returns:

characterformat

getparagraphformat

public paragraphformat getparagraphformat()

returns paragraph format of list level.

returns:

paragraphformat

getfollowcharacter

public followcharactertype getfollowcharacter()

get the type of character following the number text for the paragraph.

returns:

followcharactertype

setfollowcharacter

public void setfollowcharacter(followcharactertype value)

set the type of character following the number text for the paragraph.

parameters:

value - followcharactertype

islegalstylenumbering

public boolean islegalstylenumbering()

get arabaicnumberformat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).

returns:

boolean

islegalstylenumbering

public void islegalstylenumbering(boolean value)

set arabaicnumberformat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).

parameters:

value - boolean

getnumberposition

public float getnumberposition()

get number/bullet position for current listlevel.

returns:

float

setnumberposition

public void setnumberposition(float value)

set number/bullet position for current listlevel.

parameters:

value - float

getuseprevlevelpattern

public boolean getuseprevlevelpattern()

when true, number generated will include previous levels (used for legal numbering).

returns:

boolean

setuseprevlevelpattern

public void setuseprevlevelpattern(boolean value)

when true, number generated will include previous levels (used for legal numbering).

parameters:

value - boolean

createlayoutdata

public void createlayoutdata(java.lang.string numstr,
                             byte[] characteroffsets,
                             int levelnumber)

create level layout data

parameters:

numstr - numstr

characteroffsets - characteroffsets

levelnumber - levelnumber

getlistitemtext

public java.lang.string getlistitemtext(int listitemindex,
                                        listtype listtype)

gets list symbol for specified item index

parameters:

listitemindex - listitemindex

listtype - listtype

returns:

string

deepclone

public listlevel deepclone()

clones this instance.

returns:

listlevel