Enum ExportListLabels
Enum ExportListLabels
Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (25.12.0)
Specifies how list labels are exported to HTML, MHTML and EPUB.
public enum ExportListLabelsFields
AsInlineText = 1
Outputs all list labels as inline text.
HTML <p> tag is used for any list label representation.
Auto = 0
Outputs list labels in auto mode. Uses HTML native elements when possible.
HTML <ul> and <ol> tags are used for list label representation if it doesn’t cause formatting loss, otherwise the HTML <p> tag is used.
ByHtmlTags = 2
Outputs all list labels as HTML native elements.
HTML <ul> and <ol> tags are used for list label representation. Some formatting loss is possible.
Examples
Shows how to configure list exporting to HTML.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Aspose.Words.Lists.List docList = doc.Lists.Add(ListTemplate.NumberDefault);
builder.ListFormat.List = docList;
builder.Writeln("Default numbered list item 1.");
builder.Writeln("Default numbered list item 2.");
builder.ListFormat.ListIndent();
builder.Writeln("Default numbered list item 3.");
builder.ListFormat.RemoveNumbers();
docList = doc.Lists.Add(ListTemplate.OutlineHeadingsLegal);
builder.ListFormat.List = docList;
builder.Writeln("Outline legal heading list item 1.");
builder.Writeln("Outline legal heading list item 2.");
builder.ListFormat.ListIndent();
builder.Writeln("Outline legal heading list item 3.");
builder.ListFormat.ListIndent();
builder.Writeln("Outline legal heading list item 4.");
builder.ListFormat.ListIndent();
builder.Writeln("Outline legal heading list item 5.");
builder.ListFormat.RemoveNumbers();
// When saving the document to HTML, we can pass a SaveOptions object
// to decide which HTML elements the document will use to represent lists.
// Setting the "ExportListLabels" property to "ExportListLabels.AsInlineText"
// will create lists by formatting spans.
// Setting the "ExportListLabels" property to "ExportListLabels.Auto" will use the <p> tag
// to build lists in cases when using the <ol> and <li> tags may cause loss of formatting.
// Setting the "ExportListLabels" property to "ExportListLabels.ByHtmlTags"
// will use <ol> and <li> tags to build all lists.
HtmlSaveOptions options = new HtmlSaveOptions { ExportListLabels = exportListLabels };
doc.Save(ArtifactsDir + "HtmlSaveOptions.List.html", options);
string outDocContents = File.ReadAllText(ArtifactsDir + "HtmlSaveOptions.List.html");
switch (exportListLabels)
{
case ExportListLabels.AsInlineText:
Assert.That(outDocContents.Contains(
"<p style=\"margin-top:0pt; margin-left:72pt; margin-bottom:0pt; text-indent:-18pt; -aw-import:list-item; -aw-list-level-number:1; -aw-list-number-format:'%1.'; -aw-list-number-styles:'lowerLetter'; -aw-list-number-values:'1'; -aw-list-padding-sml:9.67pt\">" +
"<span style=\"-aw-import:ignore\">" +
"<span>a.</span>" +
"<span style=\"width:9.67pt; font:7pt 'Times New Roman'; display:inline-block; -aw-import:spaces\">       </span>" +
"</span>" +
"<span>Default numbered list item 3.</span>" +
"</p>"), Is.True);
Assert.That(outDocContents.Contains(
"<p style=\"margin-top:0pt; margin-left:43.2pt; margin-bottom:0pt; text-indent:-43.2pt; -aw-import:list-item; -aw-list-level-number:3; -aw-list-number-format:'%0.%1.%2.%3'; -aw-list-number-styles:'decimal decimal decimal decimal'; -aw-list-number-values:'2 1 1 1'; -aw-list-padding-sml:10.2pt\">" +
"<span style=\"-aw-import:ignore\">" +
"<span>2.1.1.1</span>" +
"<span style=\"width:10.2pt; font:7pt 'Times New Roman'; display:inline-block; -aw-import:spaces\">       </span>" +
"</span>" +
"<span>Outline legal heading list item 5.</span>" +
"</p>"), Is.True);
break;
case ExportListLabels.Auto:
Assert.That(outDocContents.Contains(
"<ol type=\"a\" style=\"margin-right:0pt; margin-left:0pt; padding-left:0pt\">" +
"<li style=\"margin-left:31.33pt; padding-left:4.67pt\">" +
"<span>Default numbered list item 3.</span>" +
"</li>" +
"</ol>"), Is.True);
break;
case ExportListLabels.ByHtmlTags:
Assert.That(outDocContents.Contains(
"<ol type=\"a\" style=\"margin-right:0pt; margin-left:0pt; padding-left:0pt\">" +
"<li style=\"margin-left:31.33pt; padding-left:4.67pt\">" +
"<span>Default numbered list item 3.</span>" +
"</li>" +
"</ol>"), Is.True);
break;
}