Class NumberList
Class NumberList
Namespace: Aspose.Note
Assembly: Aspose.Note.dll (24.12.0)
Represents the numbered or bulleted list.
public class NumberListInheritance
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
Shows how to insert new list with chinese numbering.```csharp
string dataDir = RunExamples.GetDataDir_Text();
// Initialize OneNote document
Aspose.Note.Document doc = new Aspose.Note.Document();
// Initialize OneNote page
Aspose.Note.Page page = new Aspose.Note.Page(doc);
Outline outline = new Outline(doc);
// Apply text style settings
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
//------------------------
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
//------------------------
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.ChineseCounting, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
//------------------------
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
page.AppendChildLast(outline);
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "InsertChineseNumberList_out.one";
doc.Save(dataDir);Shows how to insert new list with numbering.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Create an object of the Document class
Document doc = new Document();
// Initialize Page class object
Aspose.Note.Page page = new Aspose.Note.Page(doc);
// Initialize Outline class object
Outline outline = new Outline(doc);
// Initialize TextStyle class object and set formatting properties
ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
// Initialize OutlineElement class objects and apply numbering
// Numbers in the same outline are automatically incremented.
OutlineElement outlineElem1 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text1 = new RichText(doc) { Text = "First", ParagraphStyle = defaultStyle };
outlineElem1.AppendChildLast(text1);
OutlineElement outlineElem2 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text2 = new RichText(doc) { Text = "Second", ParagraphStyle = defaultStyle };
outlineElem2.AppendChildLast(text2);
OutlineElement outlineElem3 = new OutlineElement(doc) { NumberList = new NumberList("{0})", NumberFormat.DecimalNumbers, "Arial", 10) };
RichText text3 = new RichText(doc) { Text = "Third", ParagraphStyle = defaultStyle };
outlineElem3.AppendChildLast(text3);
// Add outline elements
outline.AppendChildLast(outlineElem1);
outline.AppendChildLast(outlineElem2);
outline.AppendChildLast(outlineElem3);
// Add Outline node
page.AppendChildLast(outline);
// Add Page node
doc.AppendChildLast(page);
// Save OneNote document
dataDir = dataDir + "ApplyNumberingOnText_out.one";
doc.Save(dataDir);
## Constructors
### <a id="Aspose_Note_NumberList__ctor_System_String_System_String_System_Int32_"></a> NumberList\(string, string, int\)
Initializes a new instance of the Aspose.Note.NumberList class.
This instance represents a bulleted list.
```csharp
public NumberList(string bulletedSymbol, string font, int fontSize)Parameters
bulletedSymbol string
A symbol which represents a bullet.
font string
A font for the bullet.
fontSize int
A font size for the bullet.
NumberList(string, NumberFormat, string, int)
Initializes a new instance of the Aspose.Note.NumberList class. This instance represents a numbered list.
public NumberList(string format, NumberFormat numberFormat, string font, int fontSize)Parameters
format string
The format of the numbered header.
numberFormat NumberFormat
The format of the number in header.
font string
A font for the numbered header.
fontSize int
A font size for the numbered header.
Properties
Font
Gets or sets the name of the font.
public string Font { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
### <a id="Aspose_Note_NumberList_FontColor"></a> FontColor
Gets or sets the font color.
```csharp
public Color FontColor { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
### <a id="Aspose_Note_NumberList_FontSize"></a> FontSize
Gets or sets the font size.
```csharp
public int FontSize { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
### <a id="Aspose_Note_NumberList_Format"></a> Format
Gets or sets the format of the line header. For bulleted lists represents a bullet symbol.
```csharp
public string Format { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
### <a id="Aspose_Note_NumberList_IsBold"></a> IsBold
Gets or sets a value indicating whether the text style is bold.
```csharp
public bool IsBold { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
### <a id="Aspose_Note_NumberList_IsItalic"></a> IsItalic
Gets or sets a value indicating whether the text style is italic.
```csharp
public bool IsItalic { get; set; }Property Value
Examples
Shows how to retrieve information about list’s formatting.```csharp string dataDir = RunExamples.GetDataDir_Text();
// Load the document into Aspose.Note.
Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
// Retrieve a collection nodes of the outline element
IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
// Iterate through each node
foreach (OutlineElement node in nodes)
{
if (node.NumberList != null)
{
NumberList list = node.NumberList;
// Retrieve font name
Console.WriteLine("Font Name: " + list.Font);
// Retrieve font length
Console.WriteLine("Font Length: " + list.Font.Length);
// Retrieve font size
Console.WriteLine("Font Size: " + list.FontSize);
// Retrieve font color
Console.WriteLine("Font Color: " + list.FontColor);
// Retrieve format
Console.WriteLine("Font format: " + list.Format);
// Check bold
Console.WriteLine("Is bold: " + list.IsBold);
// Check italic
Console.WriteLine("Is italic: " + list.IsItalic);
Console.WriteLine();
}
}</outlineelement></outlineelement>
### <a id="Aspose_Note_NumberList_LastModifiedTime"></a> LastModifiedTime
Gets or sets the last modified time.
```csharp
public DateTime LastModifiedTime { get; set; }Property Value
NumberFormat
Gets or sets the number format used for a group of automatically numbered objects. Should be null for bulleted lists.
public NumberFormat? NumberFormat { get; set; }Property Value
Restart
Gets or sets the numeric value that overrides the automatic number value of the list item.
public int Restart { get; set; }Property Value
Methods
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object obj)Parameters
obj object
The object.
Returns
The System.Boolean.
Equals(NumberList)
Determines whether the specified object is equal to the current object.
public bool Equals(NumberList other)Parameters
other NumberList
The object.
Returns
The System.Boolean.
GetHashCode()
Serves as a hash function for the type.
public override int GetHashCode()Returns
The System.Int32.
GetNumberedListHeader(int)
Gets the numbered list header.
public string GetNumberedListHeader(int sequenceNumber)Parameters
sequenceNumber int
The sequence number in the numbered list.
Returns
A string representation of the specified sequence number.