• Post category:API
  • Запись изменена:09.05.2023

ConvertDocument([sConvertType], [bHtmlHeadings], [bBase64img], [bDemoteHeadings], [bRenderHTMLTags]) → { string }

Преобразует документ в Markdown или HTML текст.

Параметры:

НазваниеТипПо умолчаниюОписание
sConvertType«markdown» | «html»«markdown»Тип конверсии.
bHtmlHeadingsлогическийfalseОпределяет, будут ли создаваться заголовки и идентификаторы HTML, когда средство визуализации Markdown вашей целевой платформы не обрабатывает идентификаторы в стиле Markdown.
bBase64imgлогическийfalseОпределяет, будут ли изображения создаваться в формате base64.
bDemoteHeadingsлогическийfalseОпределяет, будут ли понижены все уровни заголовков в вашем документе для соответствия следующему стандарту: один H1 в качестве заголовка, H2 в качестве заголовка верхнего уровня в основном тексте.
bRenderHTMLTagsлогическийfalseОпределяет, будут ли сохранены теги HTML в вашем Markdown. Если вы просто хотите использовать случайный HTML-тег, вы можете избежать использования открывающей угловой скобки следующим образом: <tag>text</tag>. По умолчанию открывающие угловые скобки будут заменены специальными символами.

Возвращет:

Строковый тип

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph1 = oDocument.GetElement(0);
oParagraph1.AddText("Heading 1");
var oHeading1Style = oDocument.GetStyle("Heading 1");
oParagraph1.SetStyle(oHeading1Style);
var oParagraph2 = Api.CreateParagraph();
oParagraph2.AddText("This document will be converted to Markdown.");
oDocument.Push(oParagraph2);
var aSearch = oParagraph2.Search("Markdown");
aSearch[0].SetBold(true);
var oParagraph3 = Api.CreateParagraph();
oParagraph3.AddText("Heading 2");
oDocument.Push(oParagraph3);
var oHeading2Style = oDocument.GetStyle("Heading 2");
oParagraph3.SetStyle(oHeading2Style);
var oParagraph4 = Api.CreateParagraph();
oParagraph4.AddText("There is an example of two heading levels.");
oDocument.Push(oParagraph4);
var sMarkdown = Api.ConvertDocument("markdown", false, false, true, false);
var oParagraph5 = Api.CreateParagraph();
oParagraph5.AddLineBreak();
oParagraph5.AddText("Markdown").SetBold(true);
oParagraph5.AddLineBreak();
oParagraph5.AddText(sMarkdown);
oDocument.Push(oParagraph5);
builder.SaveFile("docx", "ConvertDocument.docx");
builder.CloseFile();