OneNote.Paragraph class

Пакет:

onenote

Контейнер для контента, отображаемого на странице. Объект Paragraph может содержать контент с любым типом ParagraphType.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Получает идентификатор объекта Paragraph.
image	Получает объект Image в объекте Paragraph. Вызывает исключение, если ParagraphType не является Image.
inkWords	Возвращает коллекцию рукописных фрагментов в объекте Paragraph. Вызывает исключение, если ParagraphType не является Ink.
outline	Получает объект Outline, содержащий объект Paragraph.
paragraphs	Коллекция абзацев под этим абзацем.
parentParagraph	Получает родительский объект Paragraph. Возвращает исключение, если родительского объекта абзаца не существует.
parentParagraphOrNull	Получает родительский объект Paragraph. Возвращает значение NULL, если родительский абзац не существует.
parentTableCell	Получает объект TableCell, содержащий объект Paragraph, если он существует. Если родительский элемент не является TableCell, вызывает исключение ItemNotFound.
parentTableCellOrNull	Получает объект TableCell, содержащий объект Paragraph, если он существует. Если родительский элемент не является TableCell, возвращает значение NULL.
richText	Получает объект RichText в объекте Paragraph. Вызывает исключение, если ParagraphType не является RichText. Только для чтения
table	Получает объект Table в объекте Paragraph. Создает исключение, если ParagraphType не является таблицей.
type	Получает тип объекта Paragraph.

Методы

addNoteTag(type, status)	Добавьте NoteTag в абзац.
addNoteTag(typeString, statusString)	Добавьте NoteTag в абзац.
delete()	Удаляет объект Paragraph.
getParagraphInfo()	Получение сведений о списке абзаца
insertHtmlAsSibling(insertLocation, html)	Вставляет указанный HTML-контент
insertHtmlAsSibling(insertLocationString, html)	Вставляет указанный HTML-контент
insertImageAsSibling(insertLocation, base64EncodedImage, width, height)	Вставляет изображение в указанное место.
insertImageAsSibling(insertLocationString, base64EncodedImage, width, height)	Вставляет изображение в указанное место.
insertRichTextAsSibling(insertLocation, paragraphText)	Вставляет текст абзаца в указанное место.
insertRichTextAsSibling(insertLocationString, paragraphText)	Вставляет текст абзаца в указанное место.
insertTableAsSibling(insertLocation, rowCount, columnCount, values)	Добавляет таблицу с указанным количеством строк и столбцов перед текущим абзацем или после него.
insertTableAsSibling(insertLocationString, rowCount, columnCount, values)	Добавляет таблицу с указанным количеством строк и столбцов перед текущим абзацем или после него.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный OneNote.Paragraph объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.ParagraphData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

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

context: RequestContext;

Значение свойства

OneNote.RequestContext

id

Получает идентификатор объекта Paragraph.

readonly id: string;

Значение свойства

string

Комментарии

[ Набор API: OneNoteApi 1.1 ]

image

Получает объект Image в объекте Paragraph. Вызывает исключение, если ParagraphType не является Image.

readonly image: OneNote.Image;

Значение свойства

OneNote.Image

Комментарии

[ Набор API: OneNoteApi 1.1 ]

inkWords

Возвращает коллекцию рукописных фрагментов в объекте Paragraph. Вызывает исключение, если ParagraphType не является Ink.

readonly inkWords: OneNote.InkWordCollection;

Значение свойства

OneNote.InkWordCollection

Комментарии

[ Набор API: OneNoteApi 1.1 ]

outline

Получает объект Outline, содержащий объект Paragraph.

readonly outline: OneNote.Outline;

Значение свойства

OneNote.Outline

Комментарии

[ Набор API: OneNoteApi 1.1 ]

paragraphs

Коллекция абзацев под этим абзацем.

readonly paragraphs: OneNote.ParagraphCollection;

Значение свойства

OneNote.ParagraphCollection

Комментарии

[ Набор API: OneNoteApi 1.1 ]

parentParagraph

Получает родительский объект Paragraph. Возвращает исключение, если родительского объекта абзаца не существует.

readonly parentParagraph: OneNote.Paragraph;

Значение свойства

OneNote.Paragraph

Комментарии

[ Набор API: OneNoteApi 1.1 ]

parentParagraphOrNull

Получает родительский объект Paragraph. Возвращает значение NULL, если родительский абзац не существует.

readonly parentParagraphOrNull: OneNote.Paragraph;

Значение свойства

OneNote.Paragraph

Комментарии

[ Набор API: OneNoteApi 1.1 ]

parentTableCell

Получает объект TableCell, содержащий объект Paragraph, если он существует. Если родительский элемент не является TableCell, вызывает исключение ItemNotFound.

readonly parentTableCell: OneNote.TableCell;

Значение свойства

OneNote.TableCell

Комментарии

[ Набор API: OneNoteApi 1.1 ]

parentTableCellOrNull

Получает объект TableCell, содержащий объект Paragraph, если он существует. Если родительский элемент не является TableCell, возвращает значение NULL.

readonly parentTableCellOrNull: OneNote.TableCell;

Значение свойства

OneNote.TableCell

Комментарии

[ Набор API: OneNoteApi 1.1 ]

richText

Получает объект RichText в объекте Paragraph. Вызывает исключение, если ParagraphType не является RichText. Только для чтения

readonly richText: OneNote.RichText;

Значение свойства

OneNote.RichText

Комментарии

[ Набор API: OneNoteApi 1.1 ]

table

Получает объект Table в объекте Paragraph. Создает исключение, если ParagraphType не является таблицей.

readonly table: OneNote.Table;

Значение свойства

OneNote.Table

Комментарии

[ Набор API: OneNoteApi 1.1 ]

type

Получает тип объекта Paragraph.

readonly type: OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other";

Значение свойства

OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other"

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Сведения о методе

addNoteTag(type, status)

Добавьте NoteTag в абзац.

addNoteTag(type: OneNote.NoteTagType, status: OneNote.NoteTagStatus): OneNote.NoteTag;

Параметры

type

OneNote.NoteTagType

Тип NoteTag.

status

OneNote.NoteTagStatus

Состояние NoteTag.

Возвращаемое значение

OneNote.NoteTag

Комментарии

[ Набор API: OneNoteApi 1.1 ]

addNoteTag(typeString, statusString)

Добавьте NoteTag в абзац.

addNoteTag(typeString: "Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2", statusString: "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"): OneNote.NoteTag;

Параметры

typeString

"Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2"

Тип NoteTag.

statusString

"Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"

Состояние NoteTag.

Возвращаемое значение

OneNote.NoteTag

Комментарии

[ Набор API: OneNoteApi 1.1 ]

delete()

Удаляет объект Paragraph.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    
    const paragraphs = pageContent.outline.paragraphs;
    
    const firstParagraph = paragraphs.getItemAt(0);
    
    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Queue a command to delete the first paragraph.
    firstParagraph.delete();
    
    // Run the command to delete it.
    await context.sync();
});

getParagraphInfo()

Получение сведений о списке абзаца

getParagraphInfo(): OfficeExtension.ClientResult<OneNote.ParagraphInfo>;

Возвращаемое значение

OfficeExtension.ClientResult<OneNote.ParagraphInfo>

Комментарии

[ Набор API: OneNoteApi 1.1 ]

insertHtmlAsSibling(insertLocation, html)

Вставляет указанный HTML-контент

insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void;

Параметры

insertLocation

OneNote.InsertLocation

Расположение нового содержимого относительно текущего объекта Paragraph.

html

string

Строка HTML, описывающая визуальное представление содержимого. См. раздел Поддерживаемый HTML для API JavaScript надстроек OneNote.

Возвращаемое значение

void

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page.
    // Assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;
    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Queue commands to insert before and after the first paragraph.
    firstParagraph.insertHtmlAsSibling("Before", "<p>ContentBeforeFirstParagraph</p>");
    firstParagraph.insertHtmlAsSibling("After", "<p>ContentAfterFirstParagraph</p>");
    
    // Run the command to run inserts.
    await context.sync();
});

insertHtmlAsSibling(insertLocationString, html)

Вставляет указанный HTML-контент

insertHtmlAsSibling(insertLocationString: "Before" | "After", html: string): void;

Параметры

insertLocationString

"Before" | "After"

Расположение нового содержимого относительно текущего объекта Paragraph.

html

string

Строка HTML, описывающая визуальное представление содержимого. См. раздел Поддерживаемый HTML для API JavaScript надстроек OneNote.

Возвращаемое значение

void

Комментарии

[ Набор API: OneNoteApi 1.1 ]

insertImageAsSibling(insertLocation, base64EncodedImage, width, height)

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

insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image;

Параметры

insertLocation

OneNote.InsertLocation

Расположение таблицы относительно текущего объекта Paragraph.

base64EncodedImage

string

Строка HTML, которую необходимо добавить.

width

number

Необязательный параметр. Ширина в точках. Значение по умолчанию — null, ширина изображения имеет приоритет.

height

number

Необязательный параметр. Высота в точках. Значение по умолчанию — null, высота изображения имеет приоритет.

Возвращаемое значение

OneNote.Image

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page.
    // Assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;
    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Queue commands to insert before and after the first paragraph.
    firstParagraph.insertImageAsSibling("Before", "R0lGODlhDwAPAKECAAAAzMzM/////wAAACwAAAAADwAPAAACIISPeQHsrZ5ModrLlN48CXF8m2iQ3YmmKqVlRtW4MLwWACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw==");
    firstParagraph.insertImageAsSibling("After", "R0lGODlhDwAPAKECAAAAzMzM/////wAAACwAAAAADwAPAAACIISPeQHsrZ5ModrLlN48CXF8m2iQ3YmmKqVlRtW4MLwWACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw==");
    
    // Run the command to insert images.
    await context.sync();
});

insertImageAsSibling(insertLocationString, base64EncodedImage, width, height)

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

insertImageAsSibling(insertLocationString: "Before" | "After", base64EncodedImage: string, width: number, height: number): OneNote.Image;

Параметры

insertLocationString

"Before" | "After"

Расположение таблицы относительно текущего объекта Paragraph.

base64EncodedImage

string

Строка HTML, которую необходимо добавить.

width

number

Необязательный параметр. Ширина в точках. Значение по умолчанию — null, ширина изображения имеет приоритет.

height

number

Необязательный параметр. Высота в точках. Значение по умолчанию — null, высота изображения имеет приоритет.

Возвращаемое значение

OneNote.Image

Комментарии

[ Набор API: OneNoteApi 1.1 ]

insertRichTextAsSibling(insertLocation, paragraphText)

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

insertRichTextAsSibling(insertLocation: OneNote.InsertLocation, paragraphText: string): OneNote.RichText;

Параметры

insertLocation

OneNote.InsertLocation

Расположение таблицы относительно текущего объекта Paragraph.

paragraphText

string

Строка HTML, которую необходимо добавить.

Возвращаемое значение

OneNote.RichText

Комментарии

[ Набор API: OneNoteApi 1.1 ]

Примеры

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;
    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Queue commands to insert before and after the first paragraph.
    firstParagraph.insertRichTextAsSibling("Before", "Text Appears Before Paragraph");
    firstParagraph.insertRichTextAsSibling("After", "Text Appears After Paragraph");
    
    // Run the command to insert text contents.
    await context.sync();
});

insertRichTextAsSibling(insertLocationString, paragraphText)

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

insertRichTextAsSibling(insertLocationString: "Before" | "After", paragraphText: string): OneNote.RichText;

Параметры

insertLocationString

"Before" | "After"

Расположение таблицы относительно текущего объекта Paragraph.

paragraphText

string

Строка HTML, которую необходимо добавить.

Возвращаемое значение

OneNote.RichText

Комментарии

[ Набор API: OneNoteApi 1.1 ]

insertTableAsSibling(insertLocation, rowCount, columnCount, values)

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

insertTableAsSibling(insertLocation: OneNote.InsertLocation, rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Параметры

insertLocation

OneNote.InsertLocation

Расположение таблицы относительно текущего объекта Paragraph.

rowCount

number

Количество строк в таблице.

columnCount

number

Количество столбцов в таблице.

values

string[][]

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

Возвращаемое значение

OneNote.Table

Комментарии

[ Набор API: OneNoteApi 1.1 ]

insertTableAsSibling(insertLocationString, rowCount, columnCount, values)

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

insertTableAsSibling(insertLocationString: "Before" | "After", rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Параметры

insertLocationString

"Before" | "After"

Расположение таблицы относительно текущего объекта Paragraph.

rowCount

number

Количество строк в таблице.

columnCount

number

Количество столбцов в таблице.

values

string[][]

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

Возвращаемое значение

OneNote.Table

Комментарии

[ Набор API: OneNoteApi 1.1 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: OneNote.Interfaces.ParagraphLoadOptions): OneNote.Paragraph;

Параметры

options

OneNote.Interfaces.ParagraphLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

OneNote.Paragraph

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): OneNote.Paragraph;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

OneNote.Paragraph

Примеры

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;
    
    // Queue a command to load the outline property of each pageContent.
    pageContents.load("outline");
        
    // Get the first PageContent on the page, and then get its Outline.
    const pageContent = pageContents._GetItem(0);
    const paragraphs = pageContent.outline.paragraphs;
            
    // Queue a command to load the id and type of each paragraph.
    paragraphs.load("id,type");
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    // Write the text.
    $.each(paragraphs.items, function(index, paragraph) {
        console.log("Paragraph type: " + paragraph.type);
        console.log("Paragraph ID: " + paragraph.id);
    });
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.Paragraph;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

OneNote.Paragraph

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

OneNote.Interfaces.ParagraphUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: OneNote.Paragraph): void;

Параметры

properties

OneNote.Paragraph

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный OneNote.Paragraph объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.ParagraphData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): OneNote.Interfaces.ParagraphData;

Возвращаемое значение

OneNote.Interfaces.ParagraphData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.

track(): OneNote.Paragraph;

Возвращаемое значение

OneNote.Paragraph

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): OneNote.Paragraph;

Возвращаемое значение

OneNote.Paragraph