DocumentBuilder

Наследование: java.lang.Object

public class DocumentBuilder

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

Чтобы узнать больше, посетитеDocument Builder Overview документальная статья.

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

СоздатьDocumentBuilder и связать его сgetDocument() / setDocument(com.aspose.words.Document).

DocumentBuilder имеет внутренний курсор, куда будет вставляться текст при вызовеwrite(java.lang.String), writeln(java.lang.String), M:Aspose.Words.DocumentBuilder.InsertBreak(Aspose.Words.BreakType) и другие методы. Вы можете перемещаться поDocumentBuilder переместить курсор в другое место в документе с помощью различных методов MoveToXXX.

ИспользоватьgetFont() свойство, чтобы указать форматирование символов, которое будет применяться ко всему тексту, вставляемому с текущей позиции в документе и далее.

ИспользоватьgetParagraphFormat() свойство, чтобы указать форматирование абзаца для текущего и всех абзацев, которые будут вставлены.

ИспользоватьgetPageSetup() свойство, чтобы указать свойства страницы и раздела для текущего раздела и всех разделов, которые будут вставлены.

ИспользоватьgetCellFormat() а такжеgetRowFormat() properties, чтобы указать свойства форматирования для ячеек и строк таблицы. ПользовательinsertCell() а такжеendRow() методы построения таблицы.

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

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

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

Методы

Метод	Описание
clearCellAttrs()
clearRowAttrs()
clearRunAttrs()
deleteRow(int tableIndex, int rowIndex)	Удаляет строку из таблицы.
endBookmark(String bookmarkName)	Отмечает текущую позицию в документе как конец закладки.
endColumnBookmark(String bookmarkName)	Отмечает текущую позицию в документе как конец закладки столбца.
endEditableRange()	Помечает текущую позицию в документе как редактируемый конец диапазона.
endEditableRange(EditableRangeStart start)	Помечает текущую позицию в документе как редактируемый конец диапазона.
endRow()	Завершает строку таблицы в документе.
endTable()	Завершает таблицу в документе.
equals(Object arg0)
fetchCellAttr(int key)
fetchInheritedCellAttr(int key)
fetchInheritedRowAttr(int key)
fetchInheritedRunAttr(int fontAttr)
fetchRowAttr(int key)
getBold()	Истинно, если шрифт отформатирован как полужирный.
getCellFormat()	Возвращает объект, представляющий текущие свойства форматирования ячейки таблицы.
getClass()
getCurrentNode()	Получает узел, выбранный в данный момент в этом DocumentBuilder.
getCurrentParagraph()	Получает абзац, выбранный в данный момент в этом DocumentBuilder.
getCurrentSection()	Получает раздел, выбранный в данный момент в этом DocumentBuilder.
getCurrentStory()	Получает историю, выбранную в настоящий момент в этом DocumentBuilder.
getCurrentStructuredDocumentTag()	Получает тег структурированного документа, выбранный в данный момент в этом DocumentBuilder.
getDirectCellAttr(int key)
getDirectRowAttr(int key)
getDirectRunAttr(int fontAttr)
getDocument()	ПолучаетgetDocument() / setDocument(com.aspose.words.Document) объект, к которому этот объект прикреплен.
getFont()	Возвращает объект, представляющий текущие свойства форматирования шрифта.
getItalic()	Истинно, если шрифт отформатирован как курсив.
getListFormat()	Возвращает объект, представляющий текущие свойства форматирования списка.
getPageSetup()	Возвращает объект, представляющий текущую настройку страницы и свойства раздела.
getParagraphFormat()	Возвращает объект, представляющий текущие свойства форматирования абзаца.
getRowFormat()	Возвращает объект, представляющий текущие свойства форматирования строки таблицы.
getUnderline()	Получает/устанавливает тип подчеркивания для текущего шрифта.
hashCode()
insertBreak(int breakType)
insertCell()	Вставляет ячейку таблицы в документ.
insertChart(int chartType, double width, double height)
insertChart(int chartType, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertCheckBox(String name, boolean defaultValue, boolean checkedValue, int size)	Вставляет поле формы флажка в текущую позицию.
insertCheckBox(String name, boolean checkedValue, int size)	Вставляет поле формы флажка в текущую позицию.
insertComboBox(String name, String[] items, int selectedIndex)	Вставляет поле формы со списком в текущую позицию.
insertDocument(Document srcDoc, int importFormatMode)
insertDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)
insertField(int fieldType, boolean updateField)
insertField(String fieldCode)	Вставляет поле Word в документ.
insertField(String fieldCode, String fieldValue)	Вставляет поле Word в документ без обновления результата поля.
insertFootnote(int footnoteType, String footnoteText)
insertFootnote(int footnoteType, String footnoteText, String referenceMark)
insertHorizontalRule()	Вставляет в документ фигуру горизонтальной линейки.
insertHtml(String html)	Вставляет строку HTML в документ.
insertHtml(String html, boolean useBuilderFormatting)	Вставляет строку HTML в документ.
insertHtml(String html, int options)
insertHyperlink(String displayText, String urlOrBookmark, boolean isBookmark)	Вставляет гиперссылку в документ.
insertImage(byte[] imageBytes)	Вставляет изображение из массива байтов в документ.
insertImage(byte[] imageBytes, double width, double height)	Вставляет встроенное изображение из массива байтов в документ и масштабирует его до указанного размера.
insertImage(byte[] imageBytes, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertImage(BufferedImage image)	Вставляет изображение в документ.
insertImage(BufferedImage image, double width, double height)	Вставляет встроенное изображение из объекта в документ и масштабирует его до указанного размера.
insertImage(BufferedImage image, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertImage(InputStream stream)
insertImage(InputStream stream, double width, double height)
insertImage(InputStream stream, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertImage(String fileName)	Вставляет изображение из файла или URL-адреса в документ.
insertImage(String fileName, double width, double height)	Вставляет встроенное изображение из файла или URL-адреса в документ и масштабирует его до указанного размера.
insertImage(String fileName, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertNode(Node node)	Вставляет узел перед курсором.
insertOleObject(InputStream stream, String progId, boolean asIcon, InputStream presentation)
insertOleObject(String fileName, boolean isLinked, boolean asIcon, InputStream presentation)
insertOleObject(String fileName, String progId, boolean isLinked, boolean asIcon, InputStream presentation)
insertOleObjectAsIcon(InputStream stream, String progId, String iconFile, String iconCaption)
insertOleObjectAsIcon(String fileName, boolean isLinked, String iconFile, String iconCaption)	Вставляет встроенный или связанный объект OLE в виде значка в документ.
insertOleObjectAsIcon(String fileName, String progId, boolean isLinked, String iconFile, String iconCaption)	Вставляет встроенный или связанный объект OLE в виде значка в документ.
insertOnlineVideo(String videoUrl, double width, double height)	Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
insertOnlineVideo(String videoUrl, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertOnlineVideo(String videoUrl, String videoEmbedCode, byte[] thumbnailImageBytes, double width, double height)	Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
insertOnlineVideo(String videoUrl, String videoEmbedCode, byte[] thumbnailImageBytes, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertParagraph()	Вставляет разрыв абзаца в документ.
insertShape(int shapeType, double width, double height)
insertShape(int shapeType, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)
insertSignatureLine(SignatureLineOptions signatureLineOptions)	Вставляет строку подписи в текущую позицию.
insertSignatureLine(SignatureLineOptions signatureLineOptions, int horzPos, double left, int vertPos, double top, int wrapType)
insertStyleSeparator()	Вставляет разделитель стилей в документ.
insertTableOfContents(String switches)	Вставляет в документ поле TOC (оглавление).
insertTextInput(String name, int type, String format, String fieldValue, int maxLength)
isAtEndOfParagraph()	Возвращает true, если курсор находится в конце текущего абзаца.
isAtEndOfStructuredDocumentTag()	Возвращаетtrue если курсор находится в конце тега структурированного документа.
isAtStartOfParagraph()	Возвращает true, если курсор находится в начале текущего абзаца (перед курсором нет текста).
moveTo(Node node)	Перемещает курсор на встроенный узел или в конец абзаца.
moveToBookmark(String bookmarkName)	Перемещает курсор на закладку.
moveToBookmark(String bookmarkName, boolean isStart, boolean isAfter)	Перемещает курсор к закладке с большей точностью.
moveToCell(int tableIndex, int rowIndex, int columnIndex, int characterIndex)	Перемещает курсор на ячейку таблицы в текущем разделе.
moveToDocumentEnd()	Перемещает курсор в конец документа.
moveToDocumentStart()	Перемещает курсор в начало документа.
moveToField(Field field, boolean isAfter)	Перемещает курсор в поле документа.
moveToHeaderFooter(int headerFooterType)
moveToMergeField(String fieldName)	Перемещает курсор в указанное поле слияния.
moveToMergeField(String fieldName, boolean isAfter, boolean isDeleteField)	Перемещает поле слияния в указанное поле слияния.
moveToParagraph(int paragraphIndex, int characterIndex)	Перемещает курсор на абзац в текущем разделе.
moveToSection(int sectionIndex)	Перемещает курсор в начало тела в указанном разделе.
moveToStructuredDocumentTag(StructuredDocumentTag structuredDocumentTag, int characterIndex)	Перемещает курсор на тег структурированного документа.
moveToStructuredDocumentTag(int structuredDocumentTagIndex, int characterIndex)	Перемещает курсор на тег структурированного документа в текущем разделе.
notify()
notifyAll()
popFont()	Извлекает форматирование символов, ранее сохраненное в стеке.
pushFont()	Сохраняет текущее форматирование символов в стек.
removeRunAttr(int key)
resetToDefaultAttrs()
setBold(boolean value)	Истинно, если шрифт отформатирован как полужирный.
setCellAttr(int key, Object value)
setDocument(Document value)	УстанавливаетgetDocument() / setDocument(com.aspose.words.Document) объект, к которому этот объект прикреплен.
setItalic(boolean value)	Истинно, если шрифт отформатирован как курсив.
setRowAttr(int key, Object value)
setRunAttr(int fontAttr, Object value)
setUnderline(int value)	Получает/устанавливает тип подчеркивания для текущего шрифта.
startBookmark(String bookmarkName)	Отмечает текущую позицию в документе как начало закладки.
startColumnBookmark(String bookmarkName)	Отмечает текущую позицию в документе как начало закладки столбца.
startEditableRange()	Помечает текущую позицию в документе как начало редактируемого диапазона.
startTable()	Запускает таблицу в документе.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)
write(String text)	Вставляет строку в документ в текущей позиции вставки.
writeln()	Вставляет разрыв абзаца в документ.
writeln(String text)	Вставляет строку и разрыв абзаца в документ.

DocumentBuilder()

public DocumentBuilder()

Инициализирует новый экземпляр этого класса. Создает новыйDocumentBuilder объект и присоединяет его к новомуgetDocument() / setDocument(com.aspose.words.Document) объект.

DocumentBuilder(Document doc)

public DocumentBuilder(Document doc)

Инициализирует новый экземпляр этого класса. Создает новыйDocumentBuilder объект, присоединяется к указанномуgetDocument() / setDocument(com.aspose.words.Document) объект. Курсор находится в начале документа.

Параметры:

Параметр	Тип	Описание
doc	Document	Объект Document для присоединения.

clearCellAttrs()

public void clearCellAttrs()

clearRowAttrs()

public void clearRowAttrs()

clearRunAttrs()

public void clearRunAttrs()

deleteRow(int tableIndex, int rowIndex)

public Row deleteRow(int tableIndex, int rowIndex)

Удаляет строку из таблицы.

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

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

Для параметров индекса, когда индекс больше или равен 0, он указывает индекс с самого начала, где 0 является первым элементом. Когда индекс меньше 0, он указывает индекс с конца, где -1 является последним элементом.

Параметры:

Параметр	Тип	Описание
tableIndex	int	Индекс таблицы.
rowIndex	int	Индекс строки в таблице.

Возвращает: Row - Только что удаленный узел строки.

endBookmark(String bookmarkName)

public BookmarkEnd endBookmark(String bookmarkName)

Отмечает текущую позицию в документе как конец закладки.

Закладки в документе могут перекрываться и охватывать любой диапазон. Чтобы создать действительную закладку, вам нужно вызвать обаstartBookmark(java.lang.String) а такжеendBookmark(java.lang.String) с тем жеbookmarkName параметр.

Неправильно сформированные закладки или закладки с повторяющимися именами будут игнорироваться при сохранении документа.

Параметры:

Параметр	Тип	Описание
bookmarkName	java.lang.String	Название закладки.

Возвращает: BookmarkEnd - Только что созданный конечный узел закладки.

endColumnBookmark(String bookmarkName)

public BookmarkEnd endColumnBookmark(String bookmarkName)

Отмечает текущую позицию в документе как конец закладки столбца. Позиция должна быть в ячейке таблицы.

Закладка столбца охватывает один или несколько столбцов в диапазоне строк. Чтобы создать действительную закладку, вам нужно вызвать обаstartColumnBookmark(java.lang.String) а такжеendColumnBookmark(java.lang.String) с тем жеbookmarkName параметр.

Неправильно сформированные закладки или закладки с повторяющимися именами будут игнорироваться при сохранении документа.

Фактическое положение вставленногоBookmarkEnd узел может отличаться от текущей позиции конструктора документов.

Параметры:

Параметр	Тип	Описание
bookmarkName	java.lang.String	Название закладки.

Возвращает: BookmarkEnd - Только что созданный конечный узел закладки.

endEditableRange()

public EditableRangeEnd endEditableRange()

Помечает текущую позицию в документе как редактируемый конец диапазона.

Редактируемый диапазон в документе может перекрываться и охватывать любой диапазон. Чтобы создать действительный редактируемый диапазон, вам нужно вызвать обаstartEditableRange() а такжеendEditableRange() или жеendEditableRange(com.aspose.words.EditableRangeStart) методы.

Неправильно сформированный редактируемый диапазон будет проигнорирован при сохранении документа.

Возвращает: EditableRangeEnd Только что созданный конечный узел редактируемого диапазона.

endEditableRange(EditableRangeStart start)

public EditableRangeEnd endEditableRange(EditableRangeStart start)

Помечает текущую позицию в документе как редактируемый конец диапазона.

Используйте эту перегрузку при создании вложенных редактируемых диапазонов.

Редактируемый диапазон в документе может перекрываться и охватывать любой диапазон. Чтобы создать действительный редактируемый диапазон, вам нужно вызвать обаstartEditableRange() а такжеendEditableRange() или жеendEditableRange(com.aspose.words.EditableRangeStart) методы.

Неправильно сформированный редактируемый диапазон будет проигнорирован при сохранении документа.

Параметры:

Параметр	Тип	Описание
start	EditableRangeStart	Это начало редактируемого диапазона.

Возвращает: EditableRangeEnd Только что созданный конечный узел редактируемого диапазона.

endRow()

public Row endRow()

Завершает строку таблицы в документе.

ВызовEndRow для завершения строки таблицы. Если вы позвонитеinsertCell() сразу после этого таблица продолжается с новой строки.

ИспользоватьgetRowFormat() свойство для указания форматирования строки.

Возвращает: Row - Только что законченный узел строки.

endTable()

public Table endTable()

Завершает таблицу в документе.

Этот метод следует вызывать только один раз послеendRow() назывался. Когда звонили,EndTable перемещает курсор из текущей ячейки, чтобы указать сразу после таблицы.

Возвращает: Table - Только что законченный узел таблицы.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

Возвращает: логический

fetchCellAttr(int key)

public Object fetchCellAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

fetchInheritedCellAttr(int key)

public Object fetchInheritedCellAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

fetchInheritedRowAttr(int key)

public Object fetchInheritedRowAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

fetchInheritedRunAttr(int fontAttr)

public Object fetchInheritedRunAttr(int fontAttr)

Параметры:

Параметр	Тип	Описание
fontAttr	int

Возвращает: java.lang.Объект

fetchRowAttr(int key)

public Object fetchRowAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

getBold()

public boolean getBold()

Истинно, если шрифт отформатирован как полужирный.

Возвращает: boolean - соответствующее логическое значение.

getCellFormat()

public CellFormat getCellFormat()

Возвращает объект, представляющий текущие свойства форматирования ячейки таблицы.

Возвращает: CellFormat - Объект, представляющий текущие свойства форматирования ячейки таблицы.

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getCurrentNode()

public Node getCurrentNode()

Получает узел, выбранный в данный момент в этом DocumentBuilder.

CurrentNode является курсоромDocumentBuilder и указывает наNode это прямой ребенокParagraph . Любые операции вставки, которые вы выполняете с помощьюDocumentBuilder будет вставлен передCurrentNode.

Если текущий абзац пуст или курсор находится непосредственно перед концом абзаца или тегом структурированного документа,CurrentNode возвращает ноль.

Возвращает: Node Узел, выбранный в данный момент в этом DocumentBuilder.

getCurrentParagraph()

public Paragraph getCurrentParagraph()

Получает абзац, выбранный в данный момент в этом DocumentBuilder.getCurrentNode()

Возвращает: Paragraph - Абзац, выбранный в данный момент в этом DocumentBuilder.

getCurrentSection()

public Section getCurrentSection()

Получает раздел, выбранный в данный момент в этом DocumentBuilder.

Возвращает: Section - Раздел, выбранный в данный момент в этом DocumentBuilder.

getCurrentStory()

public Story getCurrentStory()

Получает историю, выбранную в настоящий момент в этом DocumentBuilder.

Возвращает: Story - История, выбранная в данный момент в этом DocumentBuilder.

getCurrentStructuredDocumentTag()

public StructuredDocumentTag getCurrentStructuredDocumentTag()

Получает тег структурированного документа, выбранный в данный момент в этом DocumentBuilder.

Возвращает: StructuredDocumentTag - Тег структурированного документа, выбранный в данный момент в этом DocumentBuilder.

getDirectCellAttr(int key)

public Object getDirectCellAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

getDirectRowAttr(int key)

public Object getDirectRowAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

getDirectRunAttr(int fontAttr)

public Object getDirectRunAttr(int fontAttr)

Параметры:

Параметр	Тип	Описание
fontAttr	int

Возвращает: java.lang.Объект

getDocument()

public Document getDocument()

ПолучаетgetDocument() / setDocument(com.aspose.words.Document) объект, к которому этот объект прикреплен.

Возвращает: Document -getDocument() / setDocument(com.aspose.words.Document) объект, к которому этот объект прикреплен.

getFont()

public Font getFont()

Возвращает объект, представляющий текущие свойства форматирования шрифта.

ИспользоватьFont для доступа и изменения свойств форматирования шрифта.

Укажите форматирование шрифта перед вставкой текста.

Возвращает: Font - Объект, представляющий текущие свойства форматирования шрифта.

getItalic()

public boolean getItalic()

Истинно, если шрифт отформатирован как курсив.

Возвращает: boolean - соответствующее логическое значение.

getListFormat()

public ListFormat getListFormat()

Возвращает объект, представляющий текущие свойства форматирования списка.

Возвращает: ListFormat - Объект, представляющий текущие свойства форматирования списка.

getPageSetup()

public PageSetup getPageSetup()

Возвращает объект, представляющий текущую настройку страницы и свойства раздела.

Возвращает: PageSetup - Объект, представляющий текущую настройку страницы и свойства раздела.

getParagraphFormat()

public ParagraphFormat getParagraphFormat()

Возвращает объект, представляющий текущие свойства форматирования абзаца.

Возвращает: ParagraphFormat - Объект, представляющий текущие свойства форматирования абзаца.

getRowFormat()

public RowFormat getRowFormat()

Возвращает объект, представляющий текущие свойства форматирования строки таблицы.

Возвращает: RowFormat - Объект, представляющий текущие свойства форматирования строки таблицы.

getUnderline()

public int getUnderline()

Получает/устанавливает тип подчеркивания для текущего шрифта.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изUnderline константы.

hashCode()

public native int hashCode()

Возвращает: инт

insertBreak(int breakType)

public void insertBreak(int breakType)

Параметры:

Параметр	Тип	Описание
breakType	int

insertCell()

public Cell insertCell()

Вставляет ячейку таблицы в документ.

Чтобы начать стол, просто позвонитеInsertCell После этого любой контент, который вы добавляете с помощью других методовDocumentBuilder класс будет добавлен в текущую ячейку.

Чтобы начать новую ячейку в той же строке, вызовитеInsertCell опять таки.

Чтобы завершить вызов строки таблицыendRow().

ИспользоватьgetCellFormat() свойство для указания форматирования ячейки.

Возвращает: Cell - Только что вставленный узел ячейки.

insertChart(int chartType, double width, double height)

public Shape insertChart(int chartType, double width, double height)

Параметры:

Параметр	Тип	Описание
chartType	int
width	double
height	double

Возвращает: Shape

insertChart(int chartType, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertChart(int chartType, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
chartType	int
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertCheckBox(String name, boolean defaultValue, boolean checkedValue, int size)

public FormField insertCheckBox(String name, boolean defaultValue, boolean checkedValue, int size)

Вставляет поле формы флажка в текущую позицию.

Если указать имя для поля формы, то автоматически создается закладка с тем же именем.

Параметры:

Параметр	Тип	Описание
name	java.lang.String	Имя поля формы. Может быть пустой строкой. Значение длиннее 20 символов будет обрезано.
defaultValue	boolean	Значение по умолчанию поля формы флажка.
checkedValue	boolean	Текущий проверенный статус поля формы флажка.
size	int	Указывает размер флажка в пунктах. Укажите 0 для MS Word, чтобы автоматически рассчитать размер флажка.

Возвращает: FormField - Только что вставленный узел поля формы.

insertCheckBox(String name, boolean checkedValue, int size)

public FormField insertCheckBox(String name, boolean checkedValue, int size)

Вставляет поле формы флажка в текущую позицию.

Если указать имя для поля формы, то автоматически создается закладка с тем же именем.

Параметры:

Параметр	Тип	Описание
name	java.lang.String	Имя поля формы. Может быть пустой строкой. Значение длиннее 20 символов будет обрезано.
checkedValue	boolean	Проверено состояние поля формы флажка.
size	int	Указывает размер флажка в пунктах. Укажите 0 для MS Word, чтобы автоматически рассчитать размер флажка.

Возвращает: FormField - Только что вставленный узел поля формы.

insertComboBox(String name, String[] items, int selectedIndex)

public FormField insertComboBox(String name, String[] items, int selectedIndex)

Вставляет поле формы со списком в текущую позицию.

Если указать имя для поля формы, то автоматически создается закладка с тем же именем.

Параметры:

Параметр	Тип	Описание
name	java.lang.String	Имя поля формы. Может быть пустой строкой. Значение длиннее 20 символов будет обрезано.
items	java.lang.String[]	Элементы ComboBox. Максимум 25 штук.
selectedIndex	int	Индекс выбранного элемента в ComboBox.

Возвращает: FormField - Только что вставленный узел поля формы.

insertDocument(Document srcDoc, int importFormatMode)

public Node insertDocument(Document srcDoc, int importFormatMode)

Параметры:

Параметр	Тип	Описание
srcDoc	Document
importFormatMode	int

Возвращает: Node

insertDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)

public Node insertDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)

Параметры:

Параметр	Тип	Описание
srcDoc	Document
importFormatMode	int
importFormatOptions	ImportFormatOptions

Возвращает: Node

insertField(int fieldType, boolean updateField)

public Field insertField(int fieldType, boolean updateField)

Параметры:

Параметр	Тип	Описание
fieldType	int
updateField	boolean

Возвращает: Field

insertField(String fieldCode)

public Field insertField(String fieldCode)

Вставляет поле Word в документ. Вставляет поле Word в документ и обновляет результат поля.

Этот метод вставляет поле в документ и немедленно обновляет результат поля. Aspose.Words может обновлять поля большинства типов, но не всех. Подробнее см.insertField(java.lang.String, java.lang.String) перегрузка.

Параметры:

Параметр	Тип	Описание
fieldCode	java.lang.String	Код поля для вставки (без фигурных скобок).

Возвращает: Field - АField объект, представляющий вставленное поле.

insertField(String fieldCode, String fieldValue)

public Field insertField(String fieldCode, String fieldValue)

Вставляет поле Word в документ без обновления результата поля.

Поля в документах Microsoft Word состоят из кода поля и результата поля. Код поля подобен формуле, а результат поля подобен значению, которое выдает формула. Код поля также может содержать переключатели полей, которые являются дополнительными инструкциями для выполнения определенного действия.

Вы можете переключаться между отображением кодов полей и результатов в документе в Microsoft Word с помощью сочетания клавиш Alt+F9. Коды полей отображаются между фигурными скобками (\ {} ).

Чтобы создать поле, вам необходимо указать тип поля, код поля и значение поля «заполнитель». Если вы не уверены в синтаксисе определенного кода поля, сначала создайте поле в Microsoft Word и переключитесь на просмотр его кода поля.

Aspose.Words может вычислять результаты поля для большинства типов полей, но этот метод не обновляет результат поля автоматически. Поскольку результат поля не вычисляется автоматически, ожидается, что вы передадите некоторое строковое значение (или даже пустую строку), которое будет вставлено в результат поля. Это значение останется в поле результата в качестве заполнителя, пока поле не будет обновлено. Чтобы обновить результат поля, вы можете позвонитьField.update() на возвращенном вам объекте поля илиDocument.updateFields() для обновления полей во всем документе.

Параметры:

Параметр	Тип	Описание
fieldCode	java.lang.String	Код поля для вставки (без фигурных скобок).
fieldValue	java.lang.String	Значение поля для вставки. Передайте null для полей, которые не имеют значения.

Возвращает: Field - АField объект, представляющий вставленное поле.

insertFootnote(int footnoteType, String footnoteText)

public Footnote insertFootnote(int footnoteType, String footnoteText)

Параметры:

Параметр	Тип	Описание
footnoteType	int
footnoteText	java.lang.String

Возвращает: Footnote

insertFootnote(int footnoteType, String footnoteText, String referenceMark)

public Footnote insertFootnote(int footnoteType, String footnoteText, String referenceMark)

Параметры:

Параметр	Тип	Описание
footnoteType	int
footnoteText	java.lang.String
referenceMark	java.lang.String

Возвращает: Footnote

insertHorizontalRule()

public Shape insertHorizontalRule()

Вставляет в документ фигуру горизонтальной линейки.

Возвращает: Shape - Форма, которая представляет собой горизонтальное правило.

insertHtml(String html)

public void insertHtml(String html)

Вставляет строку HTML в документ.

Параметры:

Параметр	Тип	Описание
html	java.lang.String	Строка HTML для вставки в документ. Вы можете использовать этот метод для вставки фрагмента HTML или всего документа HTML.

insertHtml(String html, boolean useBuilderFormatting)

public void insertHtml(String html, boolean useBuilderFormatting)

Вставляет строку HTML в документ.

Параметры:

Параметр	Тип	Описание
html	java.lang.String	Строка HTML для вставки в документ.
useBuilderFormatting	boolean	Значение, указывающее, является ли форматирование, указанное вDocumentBuilder используется в качестве базового форматирования для текста, импортированного из HTML.

Вы можете использовать этот метод для вставки фрагмента HTML или всего документа HTML.

Когда useBuilderFormatting имеет значение false ,DocumentBuilder форматирование игнорируется, а форматирование вставленного текста основано на форматировании HTML по умолчанию. В результате текст выглядит так, как он отображается в браузерах.

Когда useBuilderFormatting имеет значение true , форматирование вставленного текста основано наDocumentBuilder форматирование, и текст выглядит так, как будто он был вставлен сwrite(java.lang.String). |

insertHtml(String html, int options)

public void insertHtml(String html, int options)

Параметры:

Параметр	Тип	Описание
html	java.lang.String
options	int

insertHyperlink(String displayText, String urlOrBookmark, boolean isBookmark)

public Field insertHyperlink(String displayText, String urlOrBookmark, boolean isBookmark)

Вставляет гиперссылку в документ.

Обратите внимание, что вам необходимо указать форматирование шрифта для отображаемого текста гиперссылки явно с помощью параметраgetFont() имущество.

Этот метод вызывает внутренние вызовыinsertField(java.lang.String) чтобы вставить в документ поле ГИПЕРССЫЛКИ MS Word.

Параметры:

Параметр	Тип	Описание
displayText	java.lang.String	Текст ссылки для отображения в документе.
urlOrBookmark	java.lang.String	Назначение ссылки. Может быть URL-адресом или названием закладки внутри документа. Этот метод всегда добавляет апострофы в начале и в конце URL-адреса.
isBookmark	boolean	Истинно, если предыдущий параметр является именем закладки внутри документа; false — предыдущий параметр является URL-адресом.

Возвращает: Field - АField объект, представляющий вставленное поле.

insertImage(byte[] imageBytes)

public Shape insertImage(byte[] imageBytes)

Вставляет изображение из массива байтов в документ. Изображение вставляется в строку и в масштабе 100%.

Параметры:

Параметр	Тип	Описание
imageBytes	byte[]	Массив байтов, содержащий изображение.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

insertImage(byte[] imageBytes, double width, double height)

public Shape insertImage(byte[] imageBytes, double width, double height)

Вставляет встроенное изображение из массива байтов в документ и масштабирует его до указанного размера.

Параметры:

Параметр	Тип	Описание
imageBytes	byte[]	Массив байтов, содержащий изображение.
width	double	Ширина изображения в точках. Может быть отрицательным или нулевым значением для запроса масштаба 100%.
height	double	Высота изображения в пунктах. Может быть отрицательным или нулевым значением для запроса масштаба 100%.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

insertImage(byte[] imageBytes, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertImage(byte[] imageBytes, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
imageBytes	byte[]
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertImage(BufferedImage image)

public Shape insertImage(BufferedImage image)

Вставляет изображение в документ. Вставляет изображение из объекта в документ. Изображение вставляется в строку и в масштабе 100%.

Параметры:

Параметр	Тип	Описание
image	java.awt.image.BufferedImage	Изображение для вставки в документ.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

Aspose.Words вставит изображение в формате PNG и с настройками по умолчанию. Если вы хотите вставить BufferedImage в другом формате или с другими настройками, вам нужно сохранить изображение в массив байтов и использоватьinsertImage(byte[]).

insertImage(BufferedImage image, double width, double height)

public Shape insertImage(BufferedImage image, double width, double height)

Вставляет встроенное изображение из объекта в документ и масштабирует его до указанного размера.

Параметры:

Параметр	Тип	Описание
image	java.awt.image.BufferedImage	Изображение для вставки в документ.
width	double	Ширина изображения в точках. Может быть отрицательным или нулевым значением для запроса масштаба 100%.
height	double	Высота изображения в пунктах. Может быть отрицательным или нулевым значением для запроса масштаба 100%.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

Aspose.Words вставит изображение в формате PNG и с настройками по умолчанию. Если вы хотите вставить BufferedImage в другом формате или с другими настройками, вам нужно сохранить изображение в массив байтов и использоватьinsertImage(byte[]).

insertImage(BufferedImage image, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertImage(BufferedImage image, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
image	java.awt.image.BufferedImage
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertImage(InputStream stream)

public Shape insertImage(InputStream stream)

Параметры:

Параметр	Тип	Описание
stream	java.io.InputStream

Возвращает: Shape

insertImage(InputStream stream, double width, double height)

public Shape insertImage(InputStream stream, double width, double height)

Параметры:

Параметр	Тип	Описание
stream	java.io.InputStream
width	double
height	double

Возвращает: Shape

insertImage(InputStream stream, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertImage(InputStream stream, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
stream	java.io.InputStream
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertImage(String fileName)

public Shape insertImage(String fileName)

Вставляет изображение из файла или URL-адреса в документ. Изображение вставляется в строку и в масштабе 100%.

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String	Файл с изображением. Может быть любым допустимым локальным или удаленным URI.

Возвращает: Shape - Только что вставленный узел изображения.

Эта перегрузка автоматически загрузит изображение перед вставкой в документ, если вы укажете удаленный URI.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

insertImage(String fileName, double width, double height)

public Shape insertImage(String fileName, double width, double height)

Вставляет встроенное изображение из файла или URL-адреса в документ и масштабирует его до указанного размера.

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String	Файл, содержащий изображение.
width	double	Ширина изображения в точках. Может быть отрицательным или нулевым значением для запроса масштаба 100%.
height	double	Высота изображения в пунктах. Может быть отрицательным или нулевым значением для запроса масштаба 100%.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

insertImage(String fileName, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertImage(String fileName, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertNode(Node node)

public void insertNode(Node node)

Вставляет узел перед курсором.

Параметры:

Параметр	Тип	Описание
node	Node

insertOleObject(InputStream stream, String progId, boolean asIcon, InputStream presentation)

public Shape insertOleObject(InputStream stream, String progId, boolean asIcon, InputStream presentation)

Параметры:

Параметр	Тип	Описание
stream	java.io.InputStream
progId	java.lang.String
asIcon	boolean
presentation	java.io.InputStream

Возвращает: Shape

insertOleObject(String fileName, boolean isLinked, boolean asIcon, InputStream presentation)

public Shape insertOleObject(String fileName, boolean isLinked, boolean asIcon, InputStream presentation)

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String
isLinked	boolean
asIcon	boolean
presentation	java.io.InputStream

Возвращает: Shape

insertOleObject(String fileName, String progId, boolean isLinked, boolean asIcon, InputStream presentation)

public Shape insertOleObject(String fileName, String progId, boolean isLinked, boolean asIcon, InputStream presentation)

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String
progId	java.lang.String
isLinked	boolean
asIcon	boolean
presentation	java.io.InputStream

Возвращает: Shape

insertOleObjectAsIcon(InputStream stream, String progId, String iconFile, String iconCaption)

public Shape insertOleObjectAsIcon(InputStream stream, String progId, String iconFile, String iconCaption)

Параметры:

Параметр	Тип	Описание
stream	java.io.InputStream
progId	java.lang.String
iconFile	java.lang.String
iconCaption	java.lang.String

Возвращает: Shape

insertOleObjectAsIcon(String fileName, boolean isLinked, String iconFile, String iconCaption)

public Shape insertOleObjectAsIcon(String fileName, boolean isLinked, String iconFile, String iconCaption)

Вставляет встроенный или связанный объект OLE в виде значка в документ. Позволяет указать файл значка и заголовок. Определяет тип объекта OLE, используя расширение файла.

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String	Полный путь к файлу.
isLinked	boolean	Если true, то вставляется связанный объект OLE, в противном случае вставляется встроенный объект OLE.
iconFile	java.lang.String	Полный путь к файлу ICO. Если значение равно null, Aspose.Words будет использовать предопределенное изображение.
iconCaption	java.lang.String	Подпись к значку. Если значение равно null, Aspose.Words будет использовать имя файла.

Возвращает: Shape Узел Shape, содержащий объект Ole и вставленный в текущую позицию Builder.

insertOleObjectAsIcon(String fileName, String progId, boolean isLinked, String iconFile, String iconCaption)

public Shape insertOleObjectAsIcon(String fileName, String progId, boolean isLinked, String iconFile, String iconCaption)

Вставляет встроенный или связанный объект OLE в виде значка в документ. Позволяет указать файл значка и заголовок. Определяет тип объекта OLE, используя заданный параметр progID.

Параметры:

Параметр	Тип	Описание
fileName	java.lang.String	Полный путь к файлу.
progId	java.lang.String	ProgId объекта OLE.
isLinked	boolean	Если true, то вставляется связанный объект OLE, в противном случае вставляется встроенный объект OLE.
iconFile	java.lang.String	Полный путь к файлу ICO. Если значение равно null, Aspose.Words будет использовать предопределенное изображение.
iconCaption	java.lang.String	Подпись к значку. Если значение равно null, Aspose.Words будет использовать имя файла.

Возвращает: Shape Узел Shape, содержащий объект Ole и вставленный в текущую позицию Builder.

insertOnlineVideo(String videoUrl, double width, double height)

public Shape insertOnlineVideo(String videoUrl, double width, double height)

Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.

Параметры:

Параметр	Тип	Описание
videoUrl	java.lang.String	URL-адрес видео.
width	double	Ширина изображения в точках. Может быть отрицательным или нулевым значением для запроса масштаба 100%.
height	double	Высота изображения в пунктах. Может быть отрицательным или нулевым значением для запроса масштаба 100%.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

Поддерживается вставка онлайн-видео со следующих ресурсов:

• https://www.youtube.com/
• https://vimeo.com/

Если ваше онлайн-видео отображается неправильно, используйтеinsertOnlineVideo(java.lang.String, java.lang.String, byte[], double, double), который принимает пользовательский встроенный HTML-код.

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

insertOnlineVideo(String videoUrl, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertOnlineVideo(String videoUrl, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
videoUrl	java.lang.String
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertOnlineVideo(String videoUrl, String videoEmbedCode, byte[] thumbnailImageBytes, double width, double height)

public Shape insertOnlineVideo(String videoUrl, String videoEmbedCode, byte[] thumbnailImageBytes, double width, double height)

Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.

Параметры:

Параметр	Тип	Описание
videoUrl	java.lang.String	URL-адрес видео.
videoEmbedCode	java.lang.String	Код для встраивания видео.
thumbnailImageBytes	byte[]	Байты миниатюры изображения.
width	double	Ширина изображения в точках. Может быть отрицательным или нулевым значением для запроса масштаба 100%.
height	double	Высота изображения в пунктах. Может быть отрицательным или нулевым значением для запроса масштаба 100%.

Возвращает: Shape - Только что вставленный узел изображения.

Вы можете изменить размер изображения, местоположение, метод позиционирования и другие параметры с помощьюShape объект, возвращаемый этим методом.

insertOnlineVideo(String videoUrl, String videoEmbedCode, byte[] thumbnailImageBytes, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertOnlineVideo(String videoUrl, String videoEmbedCode, byte[] thumbnailImageBytes, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
videoUrl	java.lang.String
videoEmbedCode	java.lang.String
thumbnailImageBytes	byte[]
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertParagraph()

public Paragraph insertParagraph()

Вставляет разрыв абзаца в документ.

Текущее форматирование абзаца, заданное параметромgetParagraphFormat() используется свойство.

Разбивает текущий абзац на два. После вставки абзаца курсор помещается в начало нового абзаца.

Возвращает: Paragraph Только что вставленный узел абзаца. Это тот же узел, что иgetCurrentParagraph().

insertShape(int shapeType, double width, double height)

public Shape insertShape(int shapeType, double width, double height)

Параметры:

Параметр	Тип	Описание
shapeType	int
width	double
height	double

Возвращает: Shape

insertShape(int shapeType, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

public Shape insertShape(int shapeType, int horzPos, double left, int vertPos, double top, double width, double height, int wrapType)

Параметры:

Параметр	Тип	Описание
shapeType	int
horzPos	int
left	double
vertPos	int
top	double
width	double
height	double
wrapType	int

Возвращает: Shape

insertSignatureLine(SignatureLineOptions signatureLineOptions)

public Shape insertSignatureLine(SignatureLineOptions signatureLineOptions)

Вставляет строку подписи в текущую позицию.

Параметры:

Параметр	Тип	Описание
signatureLineOptions	SignatureLineOptions	Объект, в котором хранятся параметры создания строки подписи.

Возвращает: Shape - Только что вставленный узел строки подписи.

insertSignatureLine(SignatureLineOptions signatureLineOptions, int horzPos, double left, int vertPos, double top, int wrapType)

public Shape insertSignatureLine(SignatureLineOptions signatureLineOptions, int horzPos, double left, int vertPos, double top, int wrapType)

Параметры:

Параметр	Тип	Описание
signatureLineOptions	SignatureLineOptions
horzPos	int
left	double
vertPos	int
top	double
wrapType	int

Возвращает: Shape

insertStyleSeparator()

public void insertStyleSeparator()

Вставляет разделитель стилей в документ. Этот метод позволяет применять разные стили абзаца к двум разным частям текстовой строки.

insertTableOfContents(String switches)

public Field insertTableOfContents(String switches)

Вставляет в документ поле TOC (оглавление).

Этот метод вставляет поле TOC (оглавление) в документ в текущей позиции.

Оглавление в документе Word может быть построено несколькими способами и отформатировано с использованием различных параметров. Способ построения и отображения таблицы в Microsoft Word управляется переключателями полей.

Самый простой способ указать переключатели — вставить и настроить оглавление в документе Word с помощью меню Вставка->Справочник->Указатель и таблицы, а затем включить отображение кодов полей, чтобы увидеть переключатели. Вы можете нажать Alt+F9 в Microsoft Word, чтобы включить или выключить отображение кодов полей.

Например, после создания оглавления в документ вставляется следующее поле:{ TOC \o “1-3” \h \z } . Вы можете скопировать**\o “1-3” \h \z** и используйте его как параметр переключателей.

Обратите внимание, чтоInsertTableOfContents только вставит поле TOC, но фактически не создаст оглавление. Оглавление создается Microsoft Word при обновлении поля.

Если вы вставите оглавление с помощью этого метода, а затем откроете файл в Microsoft Word, вы не увидите оглавление, поскольку поле TOC еще не обновлено.

В Microsoft Word поля не обновляются автоматически при открытии документа, но вы можете обновить поля в документе в любое время, нажав F9.

Параметры:

Параметр	Тип	Описание
switches	java.lang.String	Поле TOC переключается.

Возвращает: Field

insertTextInput(String name, int type, String format, String fieldValue, int maxLength)

public FormField insertTextInput(String name, int type, String format, String fieldValue, int maxLength)

Параметры:

Параметр	Тип	Описание
name	java.lang.String
type	int
format	java.lang.String
fieldValue	java.lang.String
maxLength	int

Возвращает: FormField

isAtEndOfParagraph()

public boolean isAtEndOfParagraph()

Возвращает true, если курсор находится в конце текущего абзаца.

Возвращает: boolean — Истинно, если курсор находится в конце текущего абзаца.

isAtEndOfStructuredDocumentTag()

public boolean isAtEndOfStructuredDocumentTag()

Возвращаетtrue если курсор находится в конце тега структурированного документа.

Возвращает: логический -true если курсор находится в конце тега структурированного документа.

isAtStartOfParagraph()

public boolean isAtStartOfParagraph()

Возвращает true, если курсор находится в начале текущего абзаца (перед курсором нет текста).

Возвращает: boolean — Истинно, если курсор находится в начале текущего абзаца (перед курсором нет текста).

moveTo(Node node)

public void moveTo(Node node)

Перемещает курсор на встроенный узел или в конец абзаца.

Когдаnode является узлом встроенного уровня, курсор перемещается на этот узел, и перед этим узлом будет вставлено дополнительное содержимое.

Когдаnode этоParagraphкурсор перемещается в конец абзаца, и дальнейшее содержимое будет вставлено непосредственно перед разрывом абзаца.

Когдаnode является узлом уровня блока, но не абзацем, курсор перемещается в конец первого абзаца в узел уровня блока, а дальнейшее содержимое будет вставлено непосредственно перед разрывом абзаца.

Параметры:

Параметр	Тип	Описание
node	Node	Узел должен быть абзацем или прямым потомком абзаца.

moveToBookmark(String bookmarkName)

public boolean moveToBookmark(String bookmarkName)

Перемещает курсор на закладку.

Перемещает курсор в позицию сразу после начала закладки с указанным именем.

Сравнение не чувствительно к регистру. Если закладка не найдена, возвращается false и курсор не перемещается.

Вставка нового текста не заменяет существующий текст закладки.

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

Параметры:

Параметр	Тип	Описание
bookmarkName	java.lang.String	Имя закладки, на которую нужно переместить курсор.

Возвращает: boolean - Истинно, если закладка найдена; ложно в противном случае.

moveToBookmark(String bookmarkName, boolean isStart, boolean isAfter)

public boolean moveToBookmark(String bookmarkName, boolean isStart, boolean isAfter)

Перемещает курсор к закладке с большей точностью.

Перемещает курсор в положение до или после начала или конца закладки.

Если нужная позиция не на встроенном уровне, выполняется переход к следующему абзацу.

Сравнение не чувствительно к регистру. Если закладка не найдена, возвращается false и курсор не перемещается.

Параметры:

Параметр	Тип	Описание
bookmarkName	java.lang.String	Имя закладки, на которую нужно переместить курсор.
isStart	boolean	При значении true курсор перемещается в начало закладки. При значении false перемещает курсор в конец закладки.
isAfter	boolean	При значении true курсор перемещается после начальной или конечной позиции закладки. При значении false курсор перемещается перед начальной или конечной позицией закладки.

Возвращает: boolean - Истинно, если закладка найдена; ложно в противном случае.

moveToCell(int tableIndex, int rowIndex, int columnIndex, int characterIndex)

public void moveToCell(int tableIndex, int rowIndex, int columnIndex, int characterIndex)

Перемещает курсор на ячейку таблицы в текущем разделе.

Навигация осуществляется внутри текущей истории текущего раздела.

Для параметров индекса, когда индекс больше или равен 0, он указывает индекс с самого начала, где 0 является первым элементом. Когда индекс меньше 0, он указывает индекс с конца, где -1 является последним элементом.

Параметры:

Параметр	Тип	Описание
tableIndex	int	Индекс таблицы для перехода.
rowIndex	int	Индекс строки в таблице.
columnIndex	int	Индекс столбца в таблице.
characterIndex	int	Индекс символа внутри ячейки. Отрицательное значение позволяет указать позицию от конца ячейки. Используйте -1, чтобы перейти в конец ячейки.

moveToDocumentEnd()

public void moveToDocumentEnd()

Перемещает курсор в конец документа.

moveToDocumentStart()

public void moveToDocumentStart()

Перемещает курсор в начало документа.

moveToField(Field field, boolean isAfter)

public void moveToField(Field field, boolean isAfter)

Перемещает курсор в поле документа.

Параметры:

Параметр	Тип	Описание
field	Field	Поле для перемещения курсора.
isAfter	boolean	При значении true курсор перемещается после конца поля. При значении false курсор перемещается перед началом поля.

moveToHeaderFooter(int headerFooterType)

public void moveToHeaderFooter(int headerFooterType)

Параметры:

Параметр	Тип	Описание
headerFooterType	int

moveToMergeField(String fieldName)

public boolean moveToMergeField(String fieldName)

Перемещает курсор в указанное поле слияния. Перемещает курсор в положение сразу за указанным полем слияния и удаляет поле слияния.

Обратите внимание, что этот метод удаляет поле слияния из документа после перемещения курсора.

Параметры:

Параметр	Тип	Описание
fieldName	java.lang.String	Нечувствительное к регистру имя поля слияния.

Возвращает: boolean - True, если поле слияния было найдено и курсор был перемещен; ложно в противном случае.

moveToMergeField(String fieldName, boolean isAfter, boolean isDeleteField)

public boolean moveToMergeField(String fieldName, boolean isAfter, boolean isDeleteField)

Перемещает поле слияния в указанное поле слияния.

Параметры:

Параметр	Тип	Описание
fieldName	java.lang.String	Нечувствительное к регистру имя поля слияния.
isAfter	boolean	При значении true курсор перемещается после конца поля. При значении false курсор перемещается перед началом поля.
isDeleteField	boolean	При значении true удаляет поле слияния.

Возвращает: boolean - True, если поле слияния было найдено и курсор был перемещен; ложно в противном случае.

moveToParagraph(int paragraphIndex, int characterIndex)

public void moveToParagraph(int paragraphIndex, int characterIndex)

Перемещает курсор на абзац в текущем разделе.

Навигация осуществляется внутри текущей истории текущего раздела. То есть, если вы переместите курсор к основному заголовку первого раздела, тогда параметр parapIndex задает индекс абзаца внутри этого заголовка этого раздела.

Когда paranIndex больше или равен 0, он указывает индекс от начала раздела, где 0 — это первый абзац. Когда paraIndex меньше 0, он указывает индекс с конца раздела, где -1 является последним абзацем.

Параметры:

Параметр	Тип	Описание
paragraphIndex	int	Индекс абзаца, к которому нужно перейти.
characterIndex	int	Индекс символа внутри абзаца. Отрицательное значение позволяет указать позицию от конца абзаца. Используйте -1, чтобы перейти в конец абзаца.

moveToSection(int sectionIndex)

public void moveToSection(int sectionIndex)

Перемещает курсор в начало тела в указанном разделе.

Когда sectionIndex больше или равен 0, он указывает индекс с начала документа, где 0 является первым разделом. Когда sectionIndex меньше 0, он указывает индекс с конца документа, где -1 является последним разделом.

Курсор переместится на первый абзац вBody указанного раздела.

Параметры:

Параметр	Тип	Описание
sectionIndex	int	Индекс раздела, к которому нужно перейти.

moveToStructuredDocumentTag(StructuredDocumentTag structuredDocumentTag, int characterIndex)

public void moveToStructuredDocumentTag(StructuredDocumentTag structuredDocumentTag, int characterIndex)

Перемещает курсор на тег структурированного документа.

Параметры:

Параметр	Тип	Описание
structuredDocumentTag	StructuredDocumentTag	Тег структурированного документа, к которому нужно перейти.
characterIndex	int	Индекс символа внутри тега структурированного документа. Отрицательное значение позволяет указать позицию от конца тега структурированного документа. Используйте -1, чтобы перейти в конец тега структурированного документа. Если тег структурированного документа находится на уровне блока и вы хотите переместить курсор в конец его последнего абзаца, укажите -2.

moveToStructuredDocumentTag(int structuredDocumentTagIndex, int characterIndex)

public void moveToStructuredDocumentTag(int structuredDocumentTagIndex, int characterIndex)

Перемещает курсор на тег структурированного документа в текущем разделе.

Навигация осуществляется внутри текущей истории текущего раздела. То есть, если вы переместите курсор к основному заголовку первого раздела, тогдаstructuredDocumentTagIndex укажет индекс тега структурированного документа внутри этого заголовка этого раздела.

Когда StructuredDocumentTagIndex больше или равен 0, он указывает индекс с начала раздела, где 0 является первым тегом структурированного документа. Когда StructuredDocumentTagIndex меньше 0, он указывает индекс с конца раздела, где -1 является последним тегом структурированного документа.

Параметры:

Параметр	Тип	Описание
structuredDocumentTagIndex	int	Индекс тега структурированного документа, к которому нужно перейти.
characterIndex	int	Индекс символа внутри тега структурированного документа. Отрицательное значение позволяет указать позицию от конца тега структурированного документа. Используйте -1, чтобы перейти в конец тега структурированного документа. Если тег структурированного документа находится на уровне блока и вы хотите переместить курсор в конец его последнего абзаца, укажите -2.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

popFont()

public void popFont()

Извлекает форматирование символов, ранее сохраненное в стеке.

pushFont()

public void pushFont()

Сохраняет текущее форматирование символов в стек.

removeRunAttr(int key)

public void removeRunAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

resetToDefaultAttrs()

public void resetToDefaultAttrs()

setBold(boolean value)

public void setBold(boolean value)

Истинно, если шрифт отформатирован как полужирный.

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

setCellAttr(int key, Object value)

public void setCellAttr(int key, Object value)

Параметры:

Параметр	Тип	Описание
key	int
value	java.lang.Object

setDocument(Document value)

public void setDocument(Document value)

УстанавливаетgetDocument() / setDocument(com.aspose.words.Document) объект, к которому этот объект прикреплен.

Параметры:

Параметр	Тип	Описание
value	Document	getDocument() / setDocument(com.aspose.words.Document) объект, к которому этот объект прикреплен.

setItalic(boolean value)

public void setItalic(boolean value)

Истинно, если шрифт отформатирован как курсив.

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

setRowAttr(int key, Object value)

public void setRowAttr(int key, Object value)

Параметры:

Параметр	Тип	Описание
key	int
value	java.lang.Object

setRunAttr(int fontAttr, Object value)

public void setRunAttr(int fontAttr, Object value)

Параметры:

Параметр	Тип	Описание
fontAttr	int
value	java.lang.Object

setUnderline(int value)

public void setUnderline(int value)

Получает/устанавливает тип подчеркивания для текущего шрифта.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изUnderline константы.

startBookmark(String bookmarkName)

public BookmarkStart startBookmark(String bookmarkName)

Отмечает текущую позицию в документе как начало закладки.

Закладки в документе могут перекрываться и охватывать любой диапазон. Чтобы создать действительную закладку, вам нужно вызвать обаstartBookmark(java.lang.String) а такжеendBookmark(java.lang.String) с тем жеbookmarkName параметр.

Неправильно сформированные закладки или закладки с повторяющимися именами будут игнорироваться при сохранении документа.

Параметры:

Параметр	Тип	Описание
bookmarkName	java.lang.String	Название закладки.

Возвращает: BookmarkStart Только что созданный начальный узел закладки.

startColumnBookmark(String bookmarkName)

public BookmarkStart startColumnBookmark(String bookmarkName)

Отмечает текущую позицию в документе как начало закладки столбца. Позиция должна быть в ячейке таблицы.

Закладка столбца охватывает один или несколько столбцов в диапазоне строк. Чтобы создать действительную закладку, вам нужно вызвать обаstartColumnBookmark(java.lang.String) а такжеendColumnBookmark(java.lang.String) с тем жеbookmarkName параметр.

Неправильно сформированные закладки или закладки с повторяющимися именами будут игнорироваться при сохранении документа.

Фактическое положение вставленногоBookmarkStart узел может отличаться от текущей позиции конструктора документов.

Параметры:

Параметр	Тип	Описание
bookmarkName	java.lang.String	Название закладки.

Возвращает: BookmarkStart Только что созданный начальный узел закладки.

startEditableRange()

public EditableRangeStart startEditableRange()

Помечает текущую позицию в документе как начало редактируемого диапазона.

Редактируемый диапазон в документе может перекрываться и охватывать любой диапазон. Чтобы создать действительный редактируемый диапазон, вам нужно вызвать обаstartEditableRange() а такжеendEditableRange() или жеendEditableRange(com.aspose.words.EditableRangeStart) методы.

Неправильно сформированный редактируемый диапазон будет проигнорирован при сохранении документа.

Возвращает: EditableRangeStart - Только что созданный начальный узел редактируемого диапазона.

startTable()

public Table startTable()

Запускает таблицу в документе.

Следующий метод для вызоваinsertCell().

Этот метод запускает вложенную таблицу при вызове внутри ячейки.

Возвращает: Table - Только что созданный узел таблицы.

toString()

public String toString()

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

Параметр	Тип	Описание
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int

write(String text)

public void write(String text)

Вставляет строку в документ в текущей позиции вставки. Текущее форматирование шрифта, заданное параметромgetFont() используется свойство.

Параметры:

Параметр	Тип	Описание
text	java.lang.String	Строка для вставки в документ.

writeln()

public void writeln()

Вставляет разрыв абзаца в документ.

ЗвонкиinsertParagraph().

writeln(String text)

public void writeln(String text)

Вставляет строку и разрыв абзаца в документ. Текущий шрифт и форматирование абзаца, указанныеgetFont() а такжеgetParagraphFormat() используются свойства.

Параметры:

Параметр	Тип	Описание
text	java.lang.String	Строка для вставки в документ.