Управление свойствами документа
Вступление
Microsoft Excel позволяет добавлять свойства в файлы электронных таблиц. Эти свойства документа предоставляют полезную информацию и разделены на 2 категории, как подробно описано ниже.
- Системные (встроенные) свойства. Встроенные свойства содержат общую информацию о документе, такую как название документа, имя автора, статистику документа и т. д.
- Пользовательские (настраиваемые) свойства: настраиваемые свойства, определенные конечным пользователем в виде пары “имя-значение”.
Управление свойствами документа с помощью Microsoft Excel
Microsoft Excel позволяет управлять свойствами документов файлов Excel в режиме WYSIWYG. Пожалуйста, выполните следующие шаги, чтобы открытьХарактеристики диалоговое окно в Excel 2016.
- ОтФайл меню, выберитеИнформация.
Выбор информационного меню |
---|
![]() |
- Нажмите наХарактеристикизаголовок и выберите «Дополнительные свойства».
Щелкнув Выбор дополнительных свойств |
---|
![]() |
- Управление свойствами документа файла.
Диалог свойств |
---|
![]() |
В диалоговом окне «Свойства» есть различные вкладки, такие как «Общие», «Сводка», «Статистика», «Содержание» и «Пользовательские настройки». Каждая вкладка помогает настроить различные виды информации, связанной с файлом. Вкладка Custom используется для управления пользовательскими свойствами. |
Работа со свойствами документа с помощью Aspose.Cells
Разработчики могут динамически управлять свойствами документа с помощью API Aspose.Cells. Эта функция помогает разработчикам хранить полезную информацию вместе с файлом, например, когда файл был получен, обработан, с отметкой времени и т. д.
Aspose.Cells for .NET непосредственно записывает информацию о API и номере версии в выходных документах. Например, при рендеринге Document на PDF, Aspose.Cells for .NET заполняетПрименение поле со значением «Aspose.Cells» иPDF Продюсер поле со значением, например ‘Aspose.Cells v17.9’.
Обратите внимание, что вы не можете поручить Aspose.Cells for .NET изменить или удалить эту информацию из выходных документов.
Доступ к свойствам документа
Aspose.Cells API поддерживают оба типа свойств документа, встроенные и настраиваемые. Aspose.Cells'Рабочая тетрадь класс представляет файл Excel и, как и файл Excel,Рабочая тетрадь класс может содержать несколько рабочих листов, каждый из которых представленРабочий лист класс, тогда как набор рабочих листов представленРабочий листКоллекцияучебный класс.
ИспользоватьРабочий листКоллекциядля доступа к свойствам документа файла, как описано ниже.
- Чтобы получить доступ к встроенным свойствам документа, используйтеWorksheetCollection.BuiltInDocumentProperties.
- Чтобы получить доступ к пользовательским свойствам документа, используйтеWorksheetCollection.CustomDocumentProperties.
ОбаWorksheetCollection.BuiltInDocumentProperties иWorksheetCollection.CustomDocumentProperties вернуть экземплярAspose.Cells.Properties.DocumentPropertyCollection. Эта коллекция содержитAspose.Cells.Properties.DocumentPropertyобъекты, каждый из которых представляет одно встроенное или пользовательское свойство документа.
Это зависит от требований приложения, как получить доступ к свойству, то есть; используя индекс или имя свойства изDocumentPropertyCollectionкак показано в примере ниже.
// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET | |
// The path to the documents directory. | |
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); | |
// Instantiate a Workbook object | |
// Open an Excel file | |
Workbook workbook = new Workbook(dataDir + "sample-document-properties.xlsx"); | |
// Retrieve a list of all custom document properties of the Excel file | |
Aspose.Cells.Properties.DocumentPropertyCollection customProperties = workbook.Worksheets.CustomDocumentProperties; | |
// Accessing a custom document property by using the property name | |
Aspose.Cells.Properties.DocumentProperty customProperty1 = customProperties["ContentTypeId"]; | |
Console.WriteLine(customProperty1.Name + " " + customProperty1.Value); | |
// Accessing the same custom document property by using the property index | |
Aspose.Cells.Properties.DocumentProperty customProperty2 = customProperties[0]; | |
Console.WriteLine(customProperty2.Name + " " + customProperty2.Value); |
Aspose.Cells.Properties.DocumentPropertyclass позволяет получить имя, значение и тип свойства документа:
- Чтобы получить имя свойства, используйтеDocumentProperty.Name.
- Чтобы получить значение свойства, используйтеDocumentProperty.Value. DocumentProperty.Valueвозвращает значение как объект.
- Чтобы получить тип свойства, используйтеDocumentProperty.Type . Это возвращает один изТип свойства значения перечисления. После получения типа свойства используйте один изDocumentProperty.ToXXX методы для получения значения соответствующего типа вместо использованияDocumentProperty.Value .DocumentProperty.ToXXXметоды описаны в таблице ниже.
Имя участника | Описание | Метод ToXXX |
---|---|---|
логический | Тип данных свойства — логический. | ToBool |
Датировать | Тип данных свойства — DateTime. Обратите внимание, что Microsoft Excel хранит только часть даты, время не может быть сохранено в пользовательском свойстве этого типа |
ToDateTime |
Плавать | Тип данных свойства — Double | Удвоить |
Число | Тип данных свойства — Int32. | ToInt |
Нить | Тип данных свойства — String | Нанизывать |
// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET | |
// The path to the documents directory. | |
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); | |
// Instantiate a Workbook object | |
// Open an Excel file | |
Workbook workbook = new Workbook(dataDir + "sample-document-properties.xlsx"); | |
// Retrieve a list of all custom document properties of the Excel file | |
Aspose.Cells.Properties.DocumentPropertyCollection customProperties = workbook.Worksheets.CustomDocumentProperties; | |
// Accessing a custom document property | |
Aspose.Cells.Properties.DocumentProperty customProperty1 = customProperties[0]; | |
// Storing the value of the document property as an object | |
object objectValue = customProperty1.Value; | |
// Accessing a custom document property | |
Aspose.Cells.Properties.DocumentProperty customProperty2 = customProperties[1]; | |
// Checking the type of the document property and then storing the value of the | |
// document property according to that type | |
if (customProperty2.Type == Aspose.Cells.Properties.PropertyType.String) | |
{ | |
string value = customProperty2.Value.ToString(); | |
Console.WriteLine(customProperty2.Name + " : " + value); | |
} |
Добавление или удаление пользовательских свойств документа
Как мы описали ранее в начале этого раздела, разработчики не могут добавлять или удалять встроенные свойства, поскольку эти свойства определяются системой, но можно добавлять или удалять настраиваемые свойства, поскольку они определяются пользователем.
Добавление пользовательских свойств
Aspose.Cells API-интерфейсы раскрылиДобавлять метод дляCustomDocumentPropertyCollection класс для добавления настраиваемых свойств в коллекцию.Добавлять метод добавляет свойство в файл Excel и возвращает ссылку на новое свойство документа в видеAspose.Cells.Properties.DocumentPropertyобъект.
// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET | |
// The path to the documents directory. | |
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); | |
// Instantiate a Workbook object | |
// Open an Excel file | |
Workbook workbook = new Workbook(dataDir + "sample-document-properties.xlsx"); | |
// Retrieve a list of all custom document properties of the Excel file | |
Aspose.Cells.Properties.CustomDocumentPropertyCollection customProperties = workbook.Worksheets.CustomDocumentProperties; | |
// Adding a custom document property to the Excel file | |
Aspose.Cells.Properties.DocumentProperty publisher = customProperties.Add("Publisher", "Aspose"); | |
// Saving resultant spreadsheet | |
workbook.Save(dataDir + "out_sample-document-properties.xlsx"); |
Настройка пользовательского свойства «Ссылка на контент»
Чтобы создать пользовательское свойство, связанное с содержимым заданного диапазона, вызовите методCustomDocumentPropertyCollection.AddLinkToContent метод и передать имя свойства и источник. Вы можете проверить, настроено ли свойство как связанное с содержимым, используяDocumentProperty.IsLinkedToContent имущество. Кроме того, также возможно получить исходный диапазон с помощьюИсточник собственностьДокументСвойстваучебный класс.
В примере мы используем простой шаблон файла Excel Microsoft. Рабочая книга имеет определенный именованный диапазон, помеченныйМой диапазон который ссылается на значение ячейки.
// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET | |
// The path to the documents directory. | |
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); | |
// Instantiate an object of Workbook | |
// Open an Excel file | |
Workbook workbook = new Workbook(dataDir + "sample-document-properties.xlsx"); | |
// Retrieve a list of all custom document properties of the Excel file | |
Aspose.Cells.Properties.CustomDocumentPropertyCollection customProperties = workbook.Worksheets.CustomDocumentProperties; | |
// Add link to content. | |
customProperties.AddLinkToContent("Owner", "MyRange"); | |
// Accessing the custom document property by using the property name | |
Aspose.Cells.Properties.DocumentProperty customProperty1 = customProperties["Owner"]; | |
// Check whether the property is lined to content | |
bool islinkedtocontent = customProperty1.IsLinkedToContent; | |
// Get the source for the property | |
string source = customProperty1.Source; | |
// Save the file | |
workbook.Save(dataDir + "out_sample-document-properties.xlsx"); |
Удаление пользовательских свойств
Чтобы удалить пользовательские свойства с помощью Aspose.Cells, вызовитеDocumentPropertyCollection.Removeи передайте имя удаляемого свойства документа.
// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET | |
// The path to the documents directory. | |
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); | |
// Instantiate a Workbook object | |
// Open an Excel file | |
Workbook workbook = new Workbook(dataDir + "sample-document-properties.xlsx"); | |
// Retrieve a list of all custom document properties of the Excel file | |
Aspose.Cells.Properties.DocumentPropertyCollection customProperties = workbook.Worksheets.CustomDocumentProperties; | |
// Removing a custom document property | |
customProperties.Remove("Publisher"); | |
// Save the file | |
workbook.Save(dataDir + "out_sample-document-properties.xlsx"); |