Aspose::Words::Lists Namespace Reference

Classes

class  List
 Represents formatting of a list. More...
 
class  ListCollection
 Stores and manages formatting of bulleted and numbered lists used in a document. More...
 
class  ListLabel
 Defines properties specific to a list label. More...
 
class  ListLevel
 Defines formatting for a list level. More...
 
class  ListLevelCollection
 A collection of list formatting for each level in a list. More...
 

Enumerations

enum  ListLevelAlignment { ListLevelAlignment::Left = 0, ListLevelAlignment::Center = 1, ListLevelAlignment::Right = 2 }
 Specifies alignment for the list number or bullet. More...
 
enum  ListTemplate {
  ListTemplate::BulletDefault, ListTemplate::BulletDisk = static_cast<int32_t>(BulletDefault), ListTemplate::BulletCircle, ListTemplate::BulletSquare,
  ListTemplate::BulletDiamonds, ListTemplate::BulletArrowHead, ListTemplate::BulletTick, ListTemplate::NumberDefault,
  ListTemplate::NumberArabicDot = static_cast<int32_t>(NumberDefault), ListTemplate::NumberArabicParenthesis, ListTemplate::NumberUppercaseRomanDot, ListTemplate::NumberUppercaseLetterDot,
  ListTemplate::NumberLowercaseLetterParenthesis, ListTemplate::NumberLowercaseLetterDot, ListTemplate::NumberLowercaseRomanDot, ListTemplate::OutlineNumbers,
  ListTemplate::OutlineLegal, ListTemplate::OutlineBullets, ListTemplate::OutlineHeadingsArticleSection, ListTemplate::OutlineHeadingsLegal,
  ListTemplate::OutlineHeadingsNumbers, ListTemplate::OutlineHeadingsChapter
}
 Specifies one of the predefined list formats available in Microsoft Word. More...
 
enum  ListTrailingCharacter { ListTrailingCharacter::Tab = 0, ListTrailingCharacter::Space = 1, ListTrailingCharacter::Nothing = 2 }
 Specifies the character that separates the list label from the text of the paragraph. More...
 

Functions

static bool UpdateParagraphListLabel (System::SharedPtr< Aspose::Words::Paragraph > para, System::SharedPtr< Aspose::Words::Lists::ListNumberGenerator > generator, Aspose::Words::RevisionsView view)
 
static System::String BuildFullListLabel (System::SharedPtr< Aspose::Words::Lists::ListNumberState > state, System::SharedPtr< Aspose::Words::Lists::IListLabelBuildBehaviour > behaviour, System::String separator)
 
static System::String BuildFullListLabel (System::SharedPtr< Aspose::Words::Lists::ListNumberState > state, int32_t minLevel, System::SharedPtr< Aspose::Words::Lists::IListLabelBuildBehaviour > behaviour, System::String separator)
 
static System::String BuildListLabel (System::SharedPtr< Aspose::Words::Lists::ListNumberState > state, System::SharedPtr< Aspose::Words::Lists::IListLabelBuildBehaviour > behaviour)
 

Enumeration Type Documentation

◆ ListLevelAlignment

Specifies alignment for the list number or bullet.

Used as a value for the Aspose::Words::Lists::ListLevel::get_Alignment property.

Enumerator
Left 

The list label is aligned to the left of the number position.

Center 

The list label is centered at the number position.

Right 

This list label is aligned to the right of the number position.

◆ ListTemplate

Specifies one of the predefined list formats available in Microsoft Word.

A list template value is used as a parameter into the Aspose::Words::Lists::ListCollection::Add(Aspose::Words::Lists::ListTemplate) method.

Aspose.Words list templates correspond to the 21 list templates available in the Bullets and Numbering dialog box in Microsoft Word 2003.

Enumerator
BulletDefault 

Default bulleted list with 9 levels. Bullet of the first level is a disc, bullet of the second level is a circle, bullet of the third level is a square. Then formatting repeats for the remaining levels.

Each level is indented to the right by 0.25" relative to the previous level.

Corresponds to the 1st bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

BulletDisk 

Same as BulletDefault.

Corresponds to the 1st bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

BulletCircle 

The bullet of the first level is a circle. The remaining levels are same as in BulletDefault.

Corresponds to the 2nd bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

BulletSquare 

The bullet of the first level is a square. The remaining levels are same as in BulletDefault.

Corresponds to the 3rd bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

BulletDiamonds 

The bullet of the first level is a 4-diamond Wingding character. The remaining levels are same as in BulletDefault.

Corresponds to the 5th bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

BulletArrowHead 

The bullet of the first level is an arrow head Wingding character. The remaining levels are same as in BulletDefault.

Corresponds to the 6th bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

BulletTick 

The bullet of the first level is a tick Wingding character. The remaining levels are same as in BulletDefault.

Corresponds to the 7th bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberDefault 

Default numbered list with 9 levels. Arabic numbering (1., 2., 3., ...) for the first level, lowecase letter numbering (a., b., c., ...) for the second level, lowercase roman numbering (i., ii., iii., ...) for the third level. Then formatting repeats for the remaining levels.

Each level is indented to the right by 0.25" relative to the previous level.

Corresponds to the 1st numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberArabicDot 

Same as NumberDefault.

Corresponds to the 1st numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberArabicParenthesis 

The number of the first level is "1)". The remaining levels are same as in NumberDefault.

Corresponds to the 2nd numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberUppercaseRomanDot 

The number of the first level is "I.". The remaining levels are same as in NumberDefault.

Corresponds to the 3rd numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberUppercaseLetterDot 

The number of the first level is "A.". The remaining levels are same as in NumberDefault.

Corresponds to the 4th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberLowercaseLetterParenthesis 

The number of the first level is "a)". The remaining levels are same as in NumberDefault.

Corresponds to the 5th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberLowercaseLetterDot 

The number of the first level is "a.". The remaining levels are same as in NumberDefault.

Corresponds to the 6th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

NumberLowercaseRomanDot 

The number of the first level is "i.". The remaining levels are same as in NumberDefault.

Corresponds to the 7th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineNumbers 

An outline list with levels numbered "1), a), i), (1), (a), (i), 1., a., i.".

Corresponds to the 1st outline list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineLegal 

An outline list with levels are numbered "1., 1.1., 1.1.1, ...".

Corresponds to the 2nd outline list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineBullets 

An outline lists with various bullets for different levels.

Corresponds to the 3rd outline list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineHeadingsArticleSection 

An outline list with levels linked to Heading styles.

Corresponds to the 4th outline list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineHeadingsLegal 

An outline list with levels linked to Heading styles.

Corresponds to the 5th outline list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineHeadingsNumbers 

An outline list with levels linked to Heading styles.

Corresponds to the 6th outline list template in the Bullets and Numbering dialog box in Microsoft Word.

OutlineHeadingsChapter 

An outline list with levels linked to Heading styles.

Corresponds to the 7th outline list template in the Bullets and Numbering dialog box in Microsoft Word.

◆ ListTrailingCharacter

Specifies the character that separates the list label from the text of the paragraph.

Used as a value for the Aspose::Words::Lists::ListLevel::get_TrailingCharacter property.

Enumerator
Tab 

A tab character is placed between the list label and text of the paragraph.

Space 

A space character is placed between the list label and text of the paragraph.

Nothing 

There is no separator character between the list label and text of the paragraph.

Function Documentation

◆ BuildFullListLabel() [1/2]

static System::String Aspose::Words::Lists::BuildFullListLabel ( System::SharedPtr< Aspose::Words::Lists::ListNumberState >  state,
System::SharedPtr< Aspose::Words::Lists::IListLabelBuildBehaviour >  behaviour,
System::String  separator 
)
static

◆ BuildFullListLabel() [2/2]

static System::String Aspose::Words::Lists::BuildFullListLabel ( System::SharedPtr< Aspose::Words::Lists::ListNumberState >  state,
int32_t  minLevel,
System::SharedPtr< Aspose::Words::Lists::IListLabelBuildBehaviour >  behaviour,
System::String  separator 
)
static

◆ BuildListLabel()

static System::String Aspose::Words::Lists::BuildListLabel ( System::SharedPtr< Aspose::Words::Lists::ListNumberState >  state,
System::SharedPtr< Aspose::Words::Lists::IListLabelBuildBehaviour >  behaviour 
)
static

◆ UpdateParagraphListLabel()

static bool Aspose::Words::Lists::UpdateParagraphListLabel ( System::SharedPtr< Aspose::Words::Paragraph para,
System::SharedPtr< Aspose::Words::Lists::ListNumberGenerator >  generator,
Aspose::Words::RevisionsView  view 
)
static