Class TxtListIndentation

Class TxtListIndentation

Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (25.12.0)

Specifies how list levels are indented when document is exporting to Aspose.Words.SaveFormat.Text format.

To learn more, visit the Save a Document documentation article.

public class TxtListIndentation

Inheritance

object ← TxtListIndentation

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 configure list indenting when saving a document to plaintext.

Document doc = new Document();
                                                                                     DocumentBuilder builder = new DocumentBuilder(doc);

                                                                                     // Create a list with three levels of indentation.
                                                                                     builder.ListFormat.ApplyNumberDefault();
                                                                                     builder.Writeln("Item 1");
                                                                                     builder.ListFormat.ListIndent();
                                                                                     builder.Writeln("Item 2");
                                                                                     builder.ListFormat.ListIndent(); 
                                                                                     builder.Write("Item 3");

                                                                                     // Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
                                                                                     // to modify how we save the document to plaintext.
                                                                                     TxtSaveOptions txtSaveOptions = new TxtSaveOptions();

                                                                                     // Set the "Character" property to assign a character to use
                                                                                     // for padding that simulates list indentation in plaintext.
                                                                                     txtSaveOptions.ListIndentation.Character = ' ';

                                                                                     // Set the "Count" property to specify the number of times
                                                                                     // to place the padding character for each list indent level.
                                                                                     txtSaveOptions.ListIndentation.Count = 3;

                                                                                     doc.Save(ArtifactsDir + "TxtSaveOptions.TxtListIndentation.txt", txtSaveOptions);

                                                                                     string docText = File.ReadAllText(ArtifactsDir + "TxtSaveOptions.TxtListIndentation.txt");
                                                                                     string newLine= Environment.NewLine;

                                                                                     Assert.That(docText, Is.EqualTo($"1. Item 1{newLine}" +
                                                                                                     $"   a. Item 2{newLine}" +
                                                                                                     $"      i. Item 3{newLine}"));

Constructors

TxtListIndentation() 

public TxtListIndentation()

Properties

Character

Gets or sets which character to use for indenting list levels. The default value is ‘\0’, that means there is no indentation.

public char Character { get; set; }

Property Value

char

Examples

Shows how to configure list indenting when saving a document to plaintext.

Document doc = new Document();
                                                                                     DocumentBuilder builder = new DocumentBuilder(doc);

                                                                                     // Create a list with three levels of indentation.
                                                                                     builder.ListFormat.ApplyNumberDefault();
                                                                                     builder.Writeln("Item 1");
                                                                                     builder.ListFormat.ListIndent();
                                                                                     builder.Writeln("Item 2");
                                                                                     builder.ListFormat.ListIndent(); 
                                                                                     builder.Write("Item 3");

                                                                                     // Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
                                                                                     // to modify how we save the document to plaintext.
                                                                                     TxtSaveOptions txtSaveOptions = new TxtSaveOptions();

                                                                                     // Set the "Character" property to assign a character to use
                                                                                     // for padding that simulates list indentation in plaintext.
                                                                                     txtSaveOptions.ListIndentation.Character = ' ';

                                                                                     // Set the "Count" property to specify the number of times
                                                                                     // to place the padding character for each list indent level.
                                                                                     txtSaveOptions.ListIndentation.Count = 3;

                                                                                     doc.Save(ArtifactsDir + "TxtSaveOptions.TxtListIndentation.txt", txtSaveOptions);

                                                                                     string docText = File.ReadAllText(ArtifactsDir + "TxtSaveOptions.TxtListIndentation.txt");
                                                                                     string newLine= Environment.NewLine;

                                                                                     Assert.That(docText, Is.EqualTo($"1. Item 1{newLine}" +
                                                                                                     $"   a. Item 2{newLine}" +
                                                                                                     $"      i. Item 3{newLine}"));

Count

Gets or sets how many Aspose.Words.Saving.TxtListIndentation.Character to use as indentation per one list level. The default value is 0, that means no indentation.

public int Count { get; set; }

Property Value

int

Examples

Shows how to configure list indenting when saving a document to plaintext.

Document doc = new Document();
                                                                                     DocumentBuilder builder = new DocumentBuilder(doc);

                                                                                     // Create a list with three levels of indentation.
                                                                                     builder.ListFormat.ApplyNumberDefault();
                                                                                     builder.Writeln("Item 1");
                                                                                     builder.ListFormat.ListIndent();
                                                                                     builder.Writeln("Item 2");
                                                                                     builder.ListFormat.ListIndent(); 
                                                                                     builder.Write("Item 3");

                                                                                     // Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
                                                                                     // to modify how we save the document to plaintext.
                                                                                     TxtSaveOptions txtSaveOptions = new TxtSaveOptions();

                                                                                     // Set the "Character" property to assign a character to use
                                                                                     // for padding that simulates list indentation in plaintext.
                                                                                     txtSaveOptions.ListIndentation.Character = ' ';

                                                                                     // Set the "Count" property to specify the number of times
                                                                                     // to place the padding character for each list indent level.
                                                                                     txtSaveOptions.ListIndentation.Count = 3;

                                                                                     doc.Save(ArtifactsDir + "TxtSaveOptions.TxtListIndentation.txt", txtSaveOptions);

                                                                                     string docText = File.ReadAllText(ArtifactsDir + "TxtSaveOptions.TxtListIndentation.txt");
                                                                                     string newLine= Environment.NewLine;

                                                                                     Assert.That(docText, Is.EqualTo($"1. Item 1{newLine}" +
                                                                                                     $"   a. Item 2{newLine}" +
                                                                                                     $"      i. Item 3{newLine}"));
 English