Aspose::Words::Lists::ListLevel class
Contents
[
Hide
]ListLevel class
Defines formatting for a list level. To learn more, visit the Working with Lists documentation article.
class ListLevel : public Aspose::Words::IRunAttrSource
Methods
| Method | Description |
|---|---|
| CreatePictureBullet() | Creates picture bullet shape for the current list level. |
| DeletePictureBullet() | Deletes picture bullet for the current list level. |
| Equals(const System::SharedPtr<Aspose::Words::Lists::ListLevel>&) | Compares with the specified ListLevel. |
| get_Alignment() const | Gets or sets the justification of the actual number of the list item. |
| get_CustomNumberStyleFormat() | Gets the custom number style format for this list level. For example: “a, ç, ĝ, …”. |
| get_Font() | Specifies character formatting used for the list label. |
| get_ImageData() | Returns image data of the picture bullet shape for the current list level. |
| get_IsLegal() const | True if the level turns all inherited numbers to Arabic, false if it preserves their number style. |
| get_LinkedStyle() | Gets or sets the paragraph style that is linked to this list level. |
| get_NumberFormat() const | Returns or sets the number format for the list level. |
| get_NumberPosition() const | Returns or sets the position (in points) of the number or bullet for the list level. |
| get_NumberStyle() const | Returns or sets the number style for this list level. |
| get_RestartAfterLevel() const | Sets or returns the list level that must appear before the specified list level restarts numbering. |
| get_StartAt() | Returns or sets the starting number for this list level. |
| get_TabPosition() const | Returns or sets the tab position (in points) for the list level. |
| get_TextPosition() const | Returns or sets the position (in points) for the second line of wrapping text for the list level. |
| get_TrailingCharacter() const | Returns or sets the character inserted after the number for the list level. |
| static GetEffectiveValue(int32_t, Aspose::Words::NumberStyle, const System::String&) | Reports the string representation of the ListLevel object for the specified index of the list item. Parameters specify the NumberStyle and an optional format string used when Custom is specified. |
| GetHashCode() const override | Calculates hash code for this object. |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| set_Alignment(Aspose::Words::Lists::ListLevelAlignment) | Setter for Aspose::Words::Lists::ListLevel::get_Alignment. |
| set_IsLegal(bool) | Setter for Aspose::Words::Lists::ListLevel::get_IsLegal. |
| set_LinkedStyle(const System::SharedPtr<Aspose::Words::Style>&) | Setter for Aspose::Words::Lists::ListLevel::get_LinkedStyle. |
| set_NumberFormat(const System::String&) | Setter for Aspose::Words::Lists::ListLevel::get_NumberFormat. |
| set_NumberPosition(double) | Setter for Aspose::Words::Lists::ListLevel::get_NumberPosition. |
| set_NumberStyle(Aspose::Words::NumberStyle) | Setter for Aspose::Words::Lists::ListLevel::get_NumberStyle. |
| set_RestartAfterLevel(int32_t) | Setter for Aspose::Words::Lists::ListLevel::get_RestartAfterLevel. |
| set_StartAt(int32_t) | Setter for Aspose::Words::Lists::ListLevel::get_StartAt. |
| set_TabPosition(double) | Setter for Aspose::Words::Lists::ListLevel::get_TabPosition. |
| set_TextPosition(double) | Setter for Aspose::Words::Lists::ListLevel::get_TextPosition. |
| set_TrailingCharacter(Aspose::Words::Lists::ListTrailingCharacter) | Setter for Aspose::Words::Lists::ListLevel::get_TrailingCharacter. |
| static Type() |
Remarks
You do not create objects of this class. List level objects are created automatically when a list is created. You access ListLevel objects via the ListLevelCollection collection.
Use the properties of ListLevel to specify list formatting for individual list levels.
Examples
Shows how to apply custom list formatting to paragraphs when using DocumentBuilder.
auto doc = MakeObject<Document>();
// A list allows us to organize and decorate sets of paragraphs with prefix symbols and indents.
// We can create nested lists by increasing the indent level.
// We can begin and end a list by using a document builder's "ListFormat" property.
// Each paragraph that we add between a list's start and the end will become an item in the list.
// Create a list from a Microsoft Word template, and customize the first two of its list levels.
SharedPtr<List> list = doc->get_Lists()->Add(ListTemplate::NumberDefault);
SharedPtr<ListLevel> listLevel = list->get_ListLevels()->idx_get(0);
listLevel->get_Font()->set_Color(System::Drawing::Color::get_Red());
listLevel->get_Font()->set_Size(24);
listLevel->set_NumberStyle(NumberStyle::OrdinalText);
listLevel->set_StartAt(21);
listLevel->set_NumberFormat(u"\x0000");
listLevel->set_NumberPosition(-36);
listLevel->set_TextPosition(144);
listLevel->set_TabPosition(144);
listLevel = list->get_ListLevels()->idx_get(1);
listLevel->set_Alignment(ListLevelAlignment::Right);
listLevel->set_NumberStyle(NumberStyle::Bullet);
listLevel->get_Font()->set_Name(u"Wingdings");
listLevel->get_Font()->set_Color(System::Drawing::Color::get_Blue());
listLevel->get_Font()->set_Size(24);
// This NumberFormat value will create star-shaped bullet list symbols.
listLevel->set_NumberFormat(u"\xf0af");
listLevel->set_TrailingCharacter(ListTrailingCharacter::Space);
listLevel->set_NumberPosition(144);
// Create paragraphs and apply both list levels of our custom list formatting to them.
auto builder = MakeObject<DocumentBuilder>(doc);
builder->get_ListFormat()->set_List(list);
builder->Writeln(u"The quick brown fox...");
builder->Writeln(u"The quick brown fox...");
builder->get_ListFormat()->ListIndent();
builder->Writeln(u"jumped over the lazy dog.");
builder->Writeln(u"jumped over the lazy dog.");
builder->get_ListFormat()->ListOutdent();
builder->Writeln(u"The quick brown fox...");
builder->get_ListFormat()->RemoveNumbers();
builder->get_Document()->Save(ArtifactsDir + u"Lists.CreateCustomList.docx");
See Also
- Namespace Aspose::Words::Lists
- Library Aspose.Words for C++