Word.OleFormat class
Представляет характеристики OLE (кроме связывания) для объекта OLE, элемента Управления ActiveX или поля.
- Extends
Свойства
| class |
Указывает тип класса для указанного объекта OLE, рисунка или поля. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| icon |
Указывает значок, используемый, |
| icon |
Указывает текст, отображаемый под значком для объекта OLE. |
| icon |
Указывает программный файл, в котором хранится значок объекта OLE. |
| icon |
Возвращает путь к файлу, в котором хранится значок для объекта OLE. |
| is |
Возвращает значение, указывающее, отображается ли указанный объект в виде значка. |
| is |
Указывает, сохраняется ли форматирование, выполненное в Microsoft Word связанному объекту OLE. |
| label | Возвращает строку, используемую для идентификации части связанного исходного файла. |
| prog |
Возвращает программный идентификатор ( |
Методы
| activate() | Активирует |
| activate |
Задает значение реестра Windows, определяющее приложение по умолчанию, используемое для активации указанного объекта OLE. |
| do |
Запрашивает, чтобы объект OLE выполнял одну из доступных глаголов. |
| do |
Запрашивает, чтобы объект OLE выполнял одну из доступных глаголов. |
| edit() | Открывает объект OLE для редактирования в приложении, в который он был создан. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| open() |
|
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
classType
Указывает тип класса для указанного объекта OLE, рисунка или поля.
classType: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
iconIndex
Указывает значок, используемый, displayAsIcon если свойство имеет значение true.
iconIndex: number;Значение свойства
number
Комментарии
iconLabel
Указывает текст, отображаемый под значком для объекта OLE.
iconLabel: string;Значение свойства
string
Комментарии
iconName
Указывает программный файл, в котором хранится значок объекта OLE.
iconName: string;Значение свойства
string
Комментарии
iconPath
Возвращает путь к файлу, в котором хранится значок для объекта OLE.
readonly iconPath: string;Значение свойства
string
Комментарии
isDisplayedAsIcon
Возвращает значение, указывающее, отображается ли указанный объект в виде значка.
readonly isDisplayedAsIcon: boolean;Значение свойства
boolean
Комментарии
isFormattingPreservedOnUpdate
Указывает, сохраняется ли форматирование, выполненное в Microsoft Word связанному объекту OLE.
isFormattingPreservedOnUpdate: boolean;Значение свойства
boolean
Комментарии
label
Возвращает строку, используемую для идентификации части связанного исходного файла.
readonly label: string;Значение свойства
string
Комментарии
progId
Возвращает программный идентификатор (ProgId) для указанного объекта OLE.
readonly progId: string;Значение свойства
string
Комментарии
Сведения о методе
activate()
Активирует OleFormat объект .
activate(): void;Возвращаемое значение
void
Комментарии
activateAs(classType)
Задает значение реестра Windows, определяющее приложение по умолчанию, используемое для активации указанного объекта OLE.
activateAs(classType: string): void;Параметры
- classType
-
string
Тип класса для активации.
Возвращаемое значение
void
Комментарии
doVerb(verbIndex)
Запрашивает, чтобы объект OLE выполнял одну из доступных глаголов.
doVerb(verbIndex: Word.OleVerb): void;Параметры
- verbIndex
- Word.OleVerb
Необязательный параметр. Индекс выполняемой команды.
Возвращаемое значение
void
Комментарии
doVerb(verbIndex)
Запрашивает, чтобы объект OLE выполнял одну из доступных глаголов.
doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;Параметры
- verbIndex
-
"Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"
Необязательный параметр. Индекс выполняемой команды.
Возвращаемое значение
void
Комментарии
edit()
Открывает объект OLE для редактирования в приложении, в который он был создан.
edit(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.OleFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.OleFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
open()
OleFormat Открывает объект .
open(): void;Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.OleFormatUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.OleFormat): void;Параметры
- properties
- Word.OleFormat
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.OleFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.OleFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.OleFormatData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.OleFormat;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.OleFormat;