Работа со свойствами документа
Свойства документа позволяют сохранить некоторую полезную информацию о вашем документе. Эти свойства можно разделить на две группы:
- Системные или встроенные, содержащие такие значения, как название документа, имя автора, статистика документа и другие.
- Определяемые пользователем или пользовательские, предоставляемые в виде пар имя-значение, где пользователь может определить как имя, так и значение.
Полезно знать, что информация о API и номере версии записывается непосредственно в выходные документы. Например, при преобразовании документа в PDF, Aspose.Words заполняет поле “Приложение” значением “Aspose.Words”, а поле “Производитель PDF” - значением “Aspose.Words для .NET YY.M.N”, где YY.M.N это версия Aspose.Words, используемая для преобразования. Дополнительные сведения см. в разделе Название генератора или производителя, указанное в выходных документах.
Доступ к свойствам документа
Чтобы получить доступ к свойствам документа в Aspose.Words, используйте:
-
built_in_document_properties для получения встроенных свойств.
-
custom_document_properties для получения пользовательских свойств.
built_in_document_properties и custom_document_properties представляют собой коллекции объектов DocumentProperty. Эти объекты могут быть получены с помощью свойства indexer по имени или по индексу.
built_in_document_properties дополнительно предоставляет доступ к свойствам документа с помощью набора введенных свойств, которые возвращают значения соответствующего типа. custom_document_properties позволяет добавлять или удалять свойства документа из документа.
Класс DocumentProperty позволяет получить имя, значение и тип свойства документа. value возвращает объект, но существует набор методов, позволяющих преобразовать значение свойства в определенный тип. После того, как вы узнаете, к какому типу относится свойство, вы можете использовать один из методов DocumentProperty.to_XXX, таких как DocumentProperty.__str__ и DocumentProperty.to_int, чтобы получить значение соответствующего типа.
В следующем примере кода показано, как перечислить все встроенные и пользовательские свойства в документе:
В Microsoft Word вы можете получить доступ к свойствам документа, используя меню “Файл → Свойства”.
Добавление или удаление свойств документа
Вы не можете добавлять или удалять встроенные свойства документа, используя Aspose.Words. Вы можете только изменять или обновлять их значения.
Чтобы добавить пользовательские свойства документа с помощью Aspose.Words, используйте метод add, передав имя нового свойства и значение соответствующего типа. Метод возвращает только что созданный объект DocumentProperty.
Чтобы удалить пользовательские свойства, используйте метод remove, передав ему имя свойства для удаления, или метод remove_at, чтобы удалить свойство по индексу. Вы также можете удалить все свойства, используя метод clear.
Следующий пример кода проверяет, существует ли в документе пользовательское свойство с заданным именем, и добавляет еще несколько пользовательских свойств документа:
В следующем примере кода показано, как удалить пользовательское свойство документа:
Обновление встроенных свойств документа
Aspose.Words не обновляет свойства документа автоматически, как это происходит с некоторыми свойствами Microsoft Word, но предоставляет метод для обновления некоторых статистических встроенных свойств документа. Вызовите метод update_word_count для пересчета и обновления следующих свойств:
Создайте новое пользовательское свойство, связанное с контентом
Aspose.Words предоставляет метод add_link_to_content для создания нового пользовательского свойства документа, связанного с содержимым. Это свойство возвращает только что созданный объект свойств или значение null, если значение link_source недопустимо.
В следующем примере кода показано, как настроить ссылку на пользовательское свойство:
Получение переменных документа
Вы можете получить набор переменных документа, используя свойство variables. Имена и значения переменных являются строками.
В следующем примере кода показано, как добавлять переменные документа и получать к ним доступ:
Удалить личную информацию из документа
Если вы хотите поделиться документом Word с другими пользователями, вы можете удалить личную информацию, такую как имя автора и компания. Для этого используйте свойство remove_personal_information, чтобы установить флаг, указывающий на то, что Microsoft Word удалит всю пользовательскую информацию из комментариев, правок и свойств документа при сохранении документа.
В следующем примере кода показано, как удалить личную информацию: