Функция _WordDocPropertyGet

 ↑  ←  Описание функции


_WordDocPropertyGet

Возвращает выбранное свойство документа Word.

#include <Word.au3>
_WordDocPropertyGet(ByRef $o_object, $v_property)

Параметры

$o_object Переменная объекта документа Word.Application
$v_property Выбранное свойство (См. Примечания)

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

Успех:Возвращает значение выбранного свойства
Ошибка:Возвращает 0 и устанавливает @error
@error:$_WordStatus_Success = Нет ошибок
$_WordStatus_GeneralError = Общая ошибка
$_WordStatus_ComError = Com ошибка
$_WordStatus_InvalidDataType = Неверный тип данных
$_WordStatus_InvalidObjectType = Неверный тип объекта
$_WordStatus_InvalidValue = Неверное значение
@extended:Содержит номер неисправного параметра

Примечания

Вы можете использовать индекс или имя в качестве выбранного свойства.

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

Свойства документа Word

Индекс/Имя свойства Описание
(1) "title" Заголовок.
(2) "subject" Тема.
(3) "author" Автор.
(4) "keywords" Ключевые слова.
(5) "comments" Комментарий.
(6) "template" Шаблон.
(7) "last author" Последний автор.
(8) "revision number" Редакция (номер редактирования).
(9) "application name" Имя приложения.
(10) "last print date" Дата последней печати.
(11) "creation date" Дата создания.
(12) "last save time" Дата последнего сохранения.
(13) "total editing time" Время редактирования (Number of edits to VBA project).
(14) "pages" Счётчик страниц.
(15) "words" Счётчик слов.
(16) "characters" Счётчик символов.
(17) "security" Настройки безопасности.
(18) "category" Категория.
(19) "" Не поддерживается.
(20) "manager" Руководитель.
(21) "company" Организация.
(22) "bytes" Количество байт.
(23) "lines" Счётчик строк.
(24) "paragraphs" Счётчик параграфов.
(25-28) "" Не поддерживается.
(29) "hyperlink base" База гиперссылки. When a relative link is based on a path you specify (the first part of the path that is shared by the file containing the hyperlink and the destination file), that path is the hyperlink base.
(30) "characters (with spaces)" Счётчик символов с пробелами.

См. также

_WordDocPropertySet

Пример

; *******************************************************
; Пример 1 - Create a word window, open a document,
;               then read all available document properties by index
; *******************************************************

#include <Word.au3>
$oWordApp = _WordCreate (@ScriptDir & "\Test.doc")
$oDoc = _WordDocGetCollection ($oWordApp, 0)
For $i = 1 To 30
    ConsoleWrite("Property Index " & $i & " - " & _WordDocPropertyGet ($oDoc, $i) & @CR)
Next

; *******************************************************
; Пример 2 - Create a word window, open a document,
;               then read the title, subject, and author properties by name.
; *******************************************************

#include <Word.au3>
$oWordApp = _WordCreate (@ScriptDir & "\Test.doc")
$oDoc = _WordDocGetCollection ($oWordApp, 0)
ConsoleWrite("Title - " & _WordDocPropertyGet ($oDoc, "Title") & @CRLF)
ConsoleWrite("Subject - " & _WordDocPropertyGet ($oDoc, "Subject") & @CRLF)
ConsoleWrite("Author - " & _WordDocPropertyGet ($oDoc, "Author") & @CRLF)