Поделиться через

Word.CommentContentRange class

  • Ссылка
Пакет:
word
Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.4 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

Свойства

bold

Задает значение, указывающее, выделен ли текст комментария полужирным шрифтом.
context

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

Возвращает первую гиперссылку в диапазоне или задает для него гиперссылку. При добавлении в диапазон новой гиперссылки из него удаляются все имеющиеся гиперссылки.
isEmpty

Проверяет, является ли длина диапазона нулевой.
italic

Указывает значение, указывающее, является ли текст комментария курсивом.
strikeThrough

Указывает значение, указывающее, содержит ли текст комментария зачеркивку.
text

Возвращает текст диапазона комментариев.
underline

Задает значение, указывающее тип подчеркивания текста комментария. "Нет", если текст комментария не подчеркнут.

Методы

insertText(text, insertLocation)

Вставляет текст в указанное место. Примечание. Для современного комментария диапазон содержимого, отслеживаемый в контексте, становится пустым, если какая-либо редакция комментария публикуется через пользовательский интерфейс.
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 метод переданного ему объекта.) В то время как исходный Word.CommentContentRange объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CommentContentRangeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()

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

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

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

bold

Задает значение, указывающее, выделен ли текст комментария полужирным шрифтом.

bold: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.4 ]

context

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

context: RequestContext;

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

Word.RequestContext

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

hyperlink: string;

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

string

Комментарии

[ Набор API: WordApi 1.4 ]

isEmpty

Проверяет, является ли длина диапазона нулевой.

readonly isEmpty: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.4 ]

italic

Указывает значение, указывающее, является ли текст комментария курсивом.

italic: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.4 ]

strikeThrough

Указывает значение, указывающее, содержит ли текст комментария зачеркивку.

strikeThrough: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.4 ]

text

Возвращает текст диапазона комментариев.

readonly text: string;

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

string

Комментарии

[ Набор API: WordApi 1.4 ]

underline

Задает значение, указывающее тип подчеркивания текста комментария. "Нет", если текст комментария не подчеркнут.

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

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

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

Комментарии

[ Набор API: WordApi 1.4 ]

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

insertText(text, insertLocation)

Вставляет текст в указанное место. Примечание. Для современного комментария диапазон содержимого, отслеживаемый в контексте, становится пустым, если какая-либо редакция комментария публикуется через пользовательский интерфейс.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;

Параметры

text

string

Обязательно. Текст, вставляемый в CommentContentRange.

insertLocation

Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Обязательно. Значение должно быть "Replace", "Start", "End", "Before" или "After".

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

Word.CommentContentRange

Комментарии

[ Набор API: WordApi 1.4 ]

load(options)

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

load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;

Параметры

options
Word.Interfaces.CommentContentRangeLoadOptions

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

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

Word.CommentContentRange

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.CommentContentRange;

Параметры

propertyNames

string | string[]

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

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

Word.CommentContentRange

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CommentContentRange;

Параметры

propertyNamesAndPaths

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

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

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

Word.CommentContentRange

set(properties, options)

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

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

Параметры

properties
Word.Interfaces.CommentContentRangeUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.CommentContentRange): void;

Параметры

properties
Word.CommentContentRange

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

void

toJSON()

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

toJSON(): Word.Interfaces.CommentContentRangeData;

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

Word.Interfaces.CommentContentRangeData

track()

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

track(): Word.CommentContentRange;

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

Word.CommentContentRange

untrack()

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

untrack(): Word.CommentContentRange;

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

Word.CommentContentRange