DocumentBuilder

DocumentBuilder class

Предоставляет методы для вставки текста, изображений и другого содержимого, указания шрифта, форматирования абзацев и разделов.

Чтобы узнать больше, посетитеОбзор конструктора документов статья документации.

public class DocumentBuilder

Конструкторы

Имя	Описание
DocumentBuilder()	Инициализирует новый экземпляр этого класса.
DocumentBuilder(Document)	Инициализирует новый экземпляр этого класса.

Характеристики

Имя	Описание
Bold { get; set; }	True, если шрифт отформатирован как жирный.
CellFormat { get; }	Возвращает объект, который представляет свойства форматирования текущей ячейки таблицы.
CurrentNode { get; }	Получает узел, выбранный в данный момент в этом DocumentBuilder.
CurrentParagraph { get; }	Получает абзац, выбранный в данный момент в этом`DocumentBuilder` .
CurrentSection { get; }	Получает раздел, выбранный в данный момент в этом`DocumentBuilder` .
CurrentStory { get; }	Получает историю, выбранную в данный момент в этом`DocumentBuilder` .
CurrentStructuredDocumentTag { get; }	Получает тег структурированного документа, выбранный в данный момент в этом`DocumentBuilder` .
Document { get; set; }	Получает или задает`Document`объект, к которому прикреплен этот объект.
Font { get; }	Возвращает объект, представляющий текущие свойства форматирования шрифта.
IsAtEndOfParagraph { get; }	Возвращает`истинный` если курсор находится в конце текущего абзаца.
IsAtEndOfStructuredDocumentTag { get; }	Возвращаетистинный если курсор находится в конце тега структурированного документа.
IsAtStartOfParagraph { get; }	Возвращает`истинный` если курсор находится в начале текущего абзаца (нет текста перед курсором).
Italic { get; set; }	True, если шрифт отформатирован как курсив.
ListFormat { get; }	Возвращает объект, который представляет свойства форматирования текущего списка.
PageSetup { get; }	Возвращает объект, который представляет текущие настройки страницы и свойства раздела.
ParagraphFormat { get; }	Возвращает объект, представляющий текущие свойства форматирования абзаца.
RowFormat { get; }	Возвращает объект, который представляет свойства форматирования текущей строки таблицы.
Underline { get; set; }	Получает/устанавливает тип подчеркивания для текущего шрифта.

Методы

Имя	Описание
DeleteRow(int, int)	Удаляет строку из таблицы.
EndBookmark(string)	Отмечает текущую позицию в документе как конец закладки.
EndColumnBookmark(string)	Отмечает текущую позицию в документе как конец закладки столбца. Позиция должна находиться в ячейке таблицы.
EndEditableRange()	Отмечает текущую позицию в документе как конец редактируемого диапазона.
EndEditableRange(EditableRangeStart)	Отмечает текущую позицию в документе как конец редактируемого диапазона.
EndRow()	Завершает строку таблицы в документе.
EndTable()	Завершает таблицу в документе.
InsertBreak(BreakType)	Вставляет в документ разрыв указанного типа.
InsertCell()	Вставляет ячейку таблицы в документ.
InsertChart(ChartType, double, double)	Вставляет объект диаграммы в документ и масштабирует его до указанного размера.
InsertChart(ChartType, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет объект диаграммы в документ и масштабирует его до указанного размера.
InsertCheckBox(string, bool, int)	Вставляет поле формы флажка в текущую позицию.
InsertCheckBox(string, bool, bool, int)	Вставляет поле формы флажка в текущую позицию.
InsertComboBox(string, string[], int)	Вставляет поле формы со списком в текущую позицию.
InsertDocument(Document, ImportFormatMode)	Вставляет документ в позицию курсора.
InsertDocument(Document, ImportFormatMode, ImportFormatOptions)	Вставляет документ в позицию курсора.
InsertField(string)	Вставляет поле Word в документ и обновляет результат поля.
InsertField(FieldType, bool)	Вставляет поле Word в документ и при необходимости обновляет результат поля.
InsertField(string, string)	Вставляет поле Word в документ без обновления результата поля.
InsertFootnote(FootnoteType, string)	Вставляет в документ сноску или концевую сноску.
InsertFootnote(FootnoteType, string, string)	Вставляет в документ сноску или концевую сноску.
InsertHorizontalRule()	Вставляет в документ фигуру горизонтальной линейки.
InsertHtml(string)	Вставляет в документ HTML-строку.
InsertHtml(string, bool)	Вставляет в документ HTML-строку.
InsertHtml(string, HtmlInsertOptions)	Вставляет в документ строку HTML. Позволяет указать дополнительные параметры.
InsertHyperlink(string, string, bool)	Вставляет гиперссылку в документ.
InsertImage(byte[])	Вставляет в документ изображение из байтового массива. Изображение вставляется встроенным в масштаб 100%.
InsertImage(Image)	Вставляет изображение из .NET.Image в документ. Изображение вставляется встроенным в масштаб 100%.
InsertImage(Stream)	Вставляет изображение из потока в документ. Изображение вставляется встроенным в масштаб 100%.
InsertImage(string)	Вставляет изображение из файла или URL-адреса в документ. Изображение вставляется встроенным в масштаб 100%.
InsertImage(byte[], double, double)	Вставляет в документ встроенное изображение из байтового массива и масштабирует его до указанного размера.
InsertImage(Image, double, double)	Вставляет встроенное изображение из .NET.Image объект в документ и масштабирует его до указанного размера.
InsertImage(Stream, double, double)	Вставляет встроенное изображение из потока в документ и масштабирует его до указанного размера.
InsertImage(string, double, double)	Вставляет встроенное изображение из файла или URL-адреса в документ и масштабирует его до указанного размера.
InsertImage(byte[], RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет изображение из байтового массива в указанную позицию и размер.
InsertImage(Image, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет изображение из .NET.ImageОбъект в указанном положении и размере.
InsertImage(Stream, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет изображение из потока в указанную позицию и размер.
InsertImage(string, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет изображение из файла или URL-адреса в указанную позицию и размер.
InsertNode(Node)	Вставляет узел перед курсором.
InsertOleObject(Stream, string, bool, Stream)	Вставляет внедренный объект OLE из потока в документ.
InsertOleObject(string, bool, bool, Stream)	Вставляет внедренный или связанный объект OLE из файла в документ. Обнаруживает тип объекта OLE по расширению файла.
InsertOleObject(string, string, bool, bool, Stream)	Вставляет внедренный или связанный объект OLE из файла в документ. Обнаруживает тип объекта OLE, используя заданный параметр progID.
InsertOleObjectAsIcon(Stream, string, string, string)	Вставляет внедренный объект OLE в виде значка из потока в документ. Позволяет указать файл значка и заголовок. Обнаруживает тип объекта OLE, используя заданный параметр progID.
InsertOleObjectAsIcon(string, bool, string, string)	Вставляет встроенный или связанный объект OLE в качестве значка в документ. Позволяет указать файл значка и заголовок. Обнаруживает тип объекта OLE по расширению файла.
InsertOleObjectAsIcon(string, string, bool, string, string)	Вставляет встроенный или связанный объект OLE в качестве значка в документ. Позволяет указать файл значка и заголовок. Обнаруживает тип объекта OLE, используя заданный параметр progID.
InsertOnlineVideo(string, double, double)	Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertOnlineVideo(string, string, byte[], double, double)	Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertOnlineVideo(string, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertOnlineVideo(string, string, byte[], RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertParagraph()	Вставляет в документ разрыв абзаца.
InsertShape(ShapeType, double, double)	Вставляет встроенную фигуру указанного типа и размера.
InsertShape(ShapeType, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType)	Вставляет свободно плавающую фигуру с указанным положением, размером и типом переноса текста.
InsertSignatureLine(SignatureLineOptions)	Вставляет строку подписи в текущую позицию.
InsertSignatureLine(SignatureLineOptions, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, WrapType)	Вставляет строку подписи в указанную позицию.
InsertStyleSeparator()	Вставляет в документ разделитель стилей.
InsertTableOfContents(string)	Вставляет поле TOC (оглавление) в документ.
InsertTextInput(string, TextFormFieldType, string, string, int)	Вставляет поле текстовой формы в текущую позицию.
MoveTo(Node)	Перемещает курсор к строчному узлу или в конец абзаца.
MoveToBookmark(string)	Перемещает курсор на закладку.
MoveToBookmark(string, bool, bool)	Перемещает курсор к закладке с большей точностью.
MoveToCell(int, int, int, int)	Перемещает курсор в ячейку таблицы в текущем разделе.
MoveToDocumentEnd()	Перемещает курсор в конец документа.
MoveToDocumentStart()	Перемещает курсор в начало документа.
MoveToField(Field, bool)	Перемещает курсор в поле документа.
MoveToHeaderFooter(HeaderFooterType)	Перемещает курсор в начало верхнего или нижнего колонтитула текущего раздела.
MoveToMergeField(string)	Перемещает курсор в позицию сразу за указанным полем слияния и удаляет поле слияния.
MoveToMergeField(string, bool, bool)	Перемещает поле слияния в указанное поле слияния.
MoveToParagraph(int, int)	Перемещает курсор на абзац текущего раздела.
MoveToSection(int)	Перемещает курсор в начало тела указанного раздела.
MoveToStructuredDocumentTag(int, int)	Перемещает курсор на тег структурированного документа в текущем разделе.
MoveToStructuredDocumentTag(StructuredDocumentTag, int)	Перемещает курсор к тегу структурированного документа.
PopFont()	Извлекает форматирование символов, ранее сохраненное в стеке.
PushFont()	Сохраняет текущее форматирование символов в стек.
StartBookmark(string)	Отмечает текущую позицию в документе как начало закладки.
StartColumnBookmark(string)	Отмечает текущую позицию в документе как начало закладки столбца. Позиция должна находиться в ячейке таблицы.
StartEditableRange()	Отмечает текущую позицию в документе как начало редактируемого диапазона.
StartTable()	Начинает таблицу в документе.
Write(string)	Вставляет строку в документ в текущую позицию вставки.
Writeln()	Вставляет в документ разрыв абзаца.
Writeln(string)	Вставляет в документ строку и разрыв абзаца.

Примечания

DocumentBuilder делает процесс построенияDocument проще. Document представляет собой составной объект, состоящий из дерева узлов, и хотя вставка узлов content возможна непосредственно в дерево, это требует хорошего понимания древовидной структуры. DocumentBuilder является «фасадом» сложной структурыDocument и позволяет быстро и легко вставлять контент и форматировать.

СоздатьDocumentBuilder и связать его сDocument.

DocumentBuilder имеет внутренний курсор, куда будет вставлен текст при вызовеWrite ,Writeln ,InsertBreak и другие методы. Вы можете перемещаться поDocumentBuilder курсор в другое место в документе, используя различные методы MoveToXXX.

ИспользоватьFontСвойство, позволяющее указать форматирование символов, которое будет применяться к ко всему тексту, вставленному начиная с текущей позиции в документе.

ИспользоватьParagraphFormat свойство, позволяющее указать форматирование абзаца для current и всех абзацев, которые будут вставлены.

ИспользоватьPageSetup Свойство для указания свойств страницы и раздела для раздела current и всего раздела, который будет вставлен.

ИспользоватьCellFormat иRowFormat свойства для указания свойств форматирования для ячеек и строк таблицы. ПользовательInsertCell and EndRow методы построения таблицы.

Обратите внимание, чтоFont ,ParagraphFormat иPageSetup свойства обновляются всякий раз, когда вы переходите в другое место документа, чтобы отразить свойства форматирования, доступные в новом месте.

Примеры

Показывает, как использовать построитель документов для создания таблицы.

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

// Запускаем таблицу, затем заполняем первую строку двумя ячейками.
builder.StartTable();
builder.InsertCell();
builder.Write("Row 1, Cell 1.");
builder.InsertCell();
builder.Write("Row 1, Cell 2.");

// Вызов метода построителя «EndRow», чтобы начать новую строку.
builder.EndRow();
builder.InsertCell();
builder.Write("Row 2, Cell 1.");
builder.InsertCell();
builder.Write("Row 2, Cell 2.");
builder.EndTable();

doc.Save(ArtifactsDir + "DocumentBuilder.CreateTable.docx");

Показывает, как создавать верхние и нижние колонтитулы в документе с помощью DocumentBuilder.

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

// Указываем, что нам нужны разные верхние и нижние колонтитулы для первой, четной и нечетной страниц.
builder.PageSetup.DifferentFirstPageHeaderFooter = true;
builder.PageSetup.OddAndEvenPagesHeaderFooter = true;

// Создайте заголовки, затем добавьте в документ три страницы для отображения каждого типа заголовка.
builder.MoveToHeaderFooter(HeaderFooterType.HeaderFirst);
builder.Write("Header for the first page");
builder.MoveToHeaderFooter(HeaderFooterType.HeaderEven);
builder.Write("Header for even pages");
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.Write("Header for all other pages");

builder.MoveToSection(0);
builder.Writeln("Page1");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page2");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page3");

doc.Save(ArtifactsDir + "DocumentBuilder.HeadersAndFooters.docx");

Показывает, как создать таблицу с настраиваемыми границами.

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

builder.StartTable();

// Установка параметров форматирования таблицы для построителя документов
// будет применять их к каждой строке и ячейке, которые мы добавляем вместе с ними.
builder.ParagraphFormat.Alignment = ParagraphAlignment.Center;

builder.CellFormat.ClearFormatting();
builder.CellFormat.Width = 150;
builder.CellFormat.VerticalAlignment = CellVerticalAlignment.Center;
builder.CellFormat.Shading.BackgroundPatternColor = Color.GreenYellow;
builder.CellFormat.WrapText = false;
builder.CellFormat.FitText = true;

builder.RowFormat.ClearFormatting();
builder.RowFormat.HeightRule = HeightRule.Exactly;
builder.RowFormat.Height = 50;
builder.RowFormat.Borders.LineStyle = LineStyle.Engrave3D;
builder.RowFormat.Borders.Color = Color.Orange;

builder.InsertCell();
builder.Write("Row 1, Col 1");

builder.InsertCell();
builder.Write("Row 1, Col 2");
builder.EndRow();

// При изменении форматирования оно будет применено к текущей ячейке,
// и любые новые ячейки, которые мы создадим впоследствии с помощью построителя.
// Это не повлияет на ячейки, которые мы добавили ранее.
builder.CellFormat.Shading.ClearFormatting();

builder.InsertCell();
builder.Write("Row 2, Col 1");

builder.InsertCell();
builder.Write("Row 2, Col 2");

builder.EndRow();

// Увеличиваем высоту строки, чтобы она соответствовала вертикальному тексту.
builder.InsertCell();
builder.RowFormat.Height = 150;
builder.CellFormat.Orientation = TextOrientation.Upward;
builder.Write("Row 3, Col 1");

builder.InsertCell();
builder.CellFormat.Orientation = TextOrientation.Downward;
builder.Write("Row 3, Col 2");

builder.EndRow();
builder.EndTable();

doc.Save(ArtifactsDir + "DocumentBuilder.InsertTable.docx");

Смотрите также

пространство имен Aspose.Words
сборка Aspose.Words

DocumentBase Class DocumentReaderPluginLoadException Class