Class NumberList

Namespace: Aspose.Note
Assembly: Aspose.Note.dll (25.6.0)

Represents the numbered or bulleted list.

public class NumberList
{
    private List<int> _numbers;
    public NumberList()
    {
        _numbers = new List<int>();
    }
    public void Add(int number)
    {
        _numbers.Add(number);
    }
    public int Count
    {
        get { return _numbers.Count; }
    }
    public int this[int index]
    {
        get { return _numbers[index]; }
    }
}

Inheritance

object ← NumberList

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.

string dataDir = RunExamples.GetDataDir_Text();
   Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
   IList<OutlineElement> nodes = oneFile.GetChildNodes<OutlineElement>();
   foreach (OutlineElement node in nodes)
   {
       if (node.NumberList != null)
       {
           NumberList list = node.NumberList;
           Console.WriteLine("Font Name: " + list.Font);
           Console.WriteLine("Font Length: " + list.Font.Length);
           Console.WriteLine("Font Size: " + list.FontSize);
           Console.WriteLine("Font Color: " + list.FontColor);
           Console.WriteLine("Font format: " + list.Format);
           Console.WriteLine("Is bold: " + list.IsBold);
           Console.WriteLine("Is italic: " + list.IsItalic);
           Console.WriteLine();
       }
   }

Shows how to insert new list with chinese numbering.

string dataDir = RunExamples.GetDataDir_Text();
   Aspose.Note.Document doc = new Aspose.Note.Document();
   Aspose.Note.Page page = new Aspose.Note.Page(doc);
   Outline outline = new Outline(doc);
   ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
   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);
   dataDir = dataDir + "InsertChineseNumberList_out.one";
   doc.Save(dataDir);

Shows how to insert new list with numbering.

string dataDir = RunExamples.GetDataDir_Text();
   Document doc = new Document();
   Aspose.Note.Page page = new Aspose.Note.Page(doc);
   Outline outline = new Outline(doc);
   ParagraphStyle defaultStyle = new ParagraphStyle { FontColor = Color.Black, FontName = "Arial", FontSize = 10 };
   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);
   outline.AppendChildLast(outlineElem1);
   outline.AppendChildLast(outlineElem2);
   outline.AppendChildLast(outlineElem3);
   page.AppendChildLast(outline);
   doc.AppendChildLast(page);
   dataDir += "ApplyNumberingOnText_out.one";
   doc.Save(dataDir);

Constructors

NumberList(string, string, int)

Initializes a new instance of the Aspose.Note.NumberList class.This instance represents a bulleted list.

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

string

Examples

Shows how to retrieve information about list’s formatting.

string dataDir = RunExamples.GetDataDir_Text();
   Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
   IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
   foreach (OutlineElement node in nodes)
   {
       if (node.NumberList != null)
       {
           NumberList list = node.NumberList;
           Console.WriteLine("Font Name: " + list.Font);
           Console.WriteLine("Font Length: " + list.Font.Length);
           Console.WriteLine("Font Size: " + list.FontSize);
           Console.WriteLine("Font Color: " + list.FontColor);
           Console.WriteLine("Font format: " + list.Format);
           Console.WriteLine("Is bold: " + list.IsBold);
           Console.WriteLine("Is italic: " + list.IsItalic);
           Console.WriteLine();
       }
   }

FontColor

Gets or sets the font color.

public Color FontColor
    {
        get;
        private set;
    }

Property Value

Color

Examples

Shows how to retrieve information about list’s formatting.

string dataDir = RunExamples.GetDataDir_Text();
    Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
    IList<OutlineElement> nodes = oneFile.GetChildNodes<OutlineElement>();
    foreach (OutlineElement node in nodes)
    {
        if (node.NumberList != null)
        {
            NumberList list = node.NumberList;
            Console.WriteLine("Font Name: " + list.Font);
            Console.WriteLine("Font Length: " + list.Font.Length);
            Console.WriteLine("Font Size: " + list.FontSize);
            Console.WriteLine("Font Color: " + list.FontColor);
            Console.WriteLine("Font format: " + list.Format);
            Console.WriteLine("Is bold: " + list.IsBold);
            Console.WriteLine("Is italic: " + list.IsItalic);
            Console.WriteLine();
        }
    }

string dataDir = RunExamples.GetDataDir_Text();
   Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
   IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
   foreach (OutlineElement node in nodes)
   {
       if (node.NumberList != null)
       {
           NumberList list = node.NumberList;
           Console.WriteLine("Font Name: " + list.Font);
           Console.WriteLine("Font Length: " + list.Font.Length);
           Console.WriteLine("Font Size: " + list.FontSize);
           Console.WriteLine("Font Color: " + list.FontColor);
           Console.WriteLine("Font format: " + list.Format);
           Console.WriteLine("Is bold: " + list.IsBold);
           Console.WriteLine("Is italic: " + list.IsItalic);
           Console.WriteLine();
       }
   }

Format

Gets or sets the format of the line header. For bulleted lists represents a bullet symbol.

public string Format
    {
        get;
        set;
    }

Property Value

string

Examples

Shows how to retrieve information about list’s formatting.

string dataDir = RunExamples.GetDataDir_Text();
   Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
   IList<OutlineElement> nodes = oneFile.GetChildNodes<OutlineElement>();
   foreach (OutlineElement node in nodes)
   {
      if (node.NumberList != null)
      {
         NumberList list = node.NumberList;
         Console.WriteLine("Font Name: " + list.Font);
         Console.WriteLine("Font Length: " + list.Font.Length);
         Console.WriteLine("Font Size: " + list.FontSize);
         Console.WriteLine("Font Color: " + list.FontColor);
         Console.WriteLine("Font format: " + list.Format);
         Console.WriteLine("Is bold: " + list.IsBold);
         Console.WriteLine("Is italic: " + list.IsItalic);
         Console.WriteLine();
      }
   }

IsBold

Gets or sets a value indicating whether the text style is bold.

public bool IsBold
   {
      get;
      set;
   }

Property Value

bool

Examples

Shows how to retrieve information about list’s formatting.

string dataDir = RunExamples.GetDataDir_Text();
   Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
   IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
   foreach (OutlineElement node in nodes)
   {
       if (node.NumberList != null)
       {
           NumberList list = node.NumberList;
           Console.WriteLine("Font Name: " + list.Font);
           Console.WriteLine("Font Length: " + list.Font.Length);
           Console.WriteLine("Font Size: " + list.FontSize);
           Console.WriteLine("Font Color: " + list.FontColor);
           Console.WriteLine("Font format: " + list.Format);
           Console.WriteLine("Is bold: " + list.IsBold);
           Console.WriteLine("Is italic: " + list.IsItalic);
           Console.WriteLine();
       }
   }

IsItalic

Gets or sets a value indicating whether the text style is italic.

public bool IsItalic
    {
        get;
        set;
    }

Property Value

bool

Examples

Shows how to retrieve information about list’s formatting.

string dataDir = RunExamples.GetDataDir_Text();
   Document oneFile = new Document(dataDir + "ApplyNumberingOnText.one");
   IList<outlineelement> nodes = oneFile.GetChildNodes<outlineelement>();
   foreach (OutlineElement node in nodes)
   {
       if (node.NumberList != null)
       {
           NumberList list = node.NumberList;
           Console.WriteLine("Font Name: " + list.Font);
           Console.WriteLine("Font Length: " + list.Font.Length);
           Console.WriteLine("Font Size: " + list.FontSize);
           Console.WriteLine("Font Color: " + list.FontColor);
           Console.WriteLine("Font format: " + list.Format);
           Console.WriteLine("Is bold: " + list.IsBold);
           Console.WriteLine("Is italic: " + list.IsItalic);
           Console.WriteLine();
       }
   }

LastModifiedTime

Gets or sets the last modified time.

public DateTime LastModifiedTime
    {
        get;
        private set;
    }

Property Value

DateTime

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;
      private set;
   }

Property Value

NumberFormat ?

Restart

Gets or sets the numeric value that overrides the automatic number value of the list item.

public int Restart
    {
        get;
        private set;
    }

Property Value

int

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)
   {
      if (obj == null || this.GetType() != obj.GetType())
          return false;
   }

Parameters

obj object

The object.

Returns

bool

The System.Boolean.

Equals(NumberList)

Determines whether the specified object is equal to the current object.

public bool Equals(NumberList other)
{
   if (other == null)
      return false;
   if (ReferenceEquals(this, other))
      return true;
   if (GetType() != other.GetType())
      return false;
   var thisNumbers = _numbers;
   var otherNumbers = other._numbers;
   if (thisNumbers.Length != otherNumbers.Length)
      return false;
   for (int i = 0; i < thisNumbers.Length; i++)
   {
      if (!thisNumbers[i].Equals(otherNumbers[i]))
         return false;
   }
   return true;
}

Parameters

other NumberList

The object.

Returns

bool

The System.Boolean.

GetHashCode()

Serves as a hash function for the type.

public override int GetHashCode()
    {
    }

Returns

int

The System.Int32.

GetNumberedListHeader(int)

Gets the numbered list header.

public string GetNumberedListHeader(int sequenceNumber)
   {
       string header = $"{sequenceNumber}. "; // Initialize header here
   }

Parameters

sequenceNumber int

The sequence number in the numbered list.

Returns

string

A string representation of the specified sequence number.