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
Необязательный параметр. Индекс глагола to perform.
Возвращаемое значение
void
Комментарии
doVerb(verbIndex)
Требует, чтобы объект OLE выполнил одну из доступных команд.
doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;Параметры
- verbIndex
-
"Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"
Необязательный параметр. Индекс глагола to perform.
Возвращаемое значение
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
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;