Word.LineNumbering class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
countBy	Задает числовой приращение для чисел строк.
distanceFromText	Указывает расстояние (в точках) между правым краем номеров строк и левым краем текста документа.
isActive	Указывает, активна ли нумеровка строк для указанного документа, раздела или разделов.
restartMode	Указывает способ выполнения нумеровки строк; т. е. начинается ли он сначала в начале новой страницы или раздела или выполняется непрерывно.
startingNumber	Указывает номер начальной строки.

Методы

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.LineNumbering объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.LineNumberingData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

context

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

context: RequestContext;

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

Word.RequestContext

countBy

Задает числовой приращение для чисел строк.

countBy: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

distanceFromText

Указывает расстояние (в точках) между правым краем номеров строк и левым краем текста документа.

distanceFromText: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

isActive

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

isActive: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

restartMode

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

restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage";

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

Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

startingNumber

Указывает номер начальной строки.

startingNumber: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

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

load(options)

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

load(options?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering;

Параметры

options

Word.Interfaces.LineNumberingLoadOptions

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

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

Word.LineNumbering

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.LineNumbering

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.LineNumbering

set(properties, options)

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

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

Параметры

properties

Word.Interfaces.LineNumberingUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.LineNumbering): void;

Параметры

properties

Word.LineNumbering

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

void

toJSON()

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

toJSON(): Word.Interfaces.LineNumberingData;

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

Word.Interfaces.LineNumberingData

track()

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

track(): Word.LineNumbering;

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

Word.LineNumbering

untrack()

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

untrack(): Word.LineNumbering;

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

Word.LineNumbering