Properties Dialog

  • 2 minutes to read

The Properties dialog allows end-users to view and edit document properties. Document properties are metadata that is stored with the document and contains basic information about a workbook: its title, author, file size, date of creation etc.

SpreadsheetControl_ DocPropertiesSummaryTab

The Properies dialog includes the following tabs.

  • General

    Provides general information about a workbook such as the file name, location, size, dates when the document was created or last modified. This tab is blank until an end-user saves a document, after that, the general properties are automatically set by the system and cannot be changed.

  • Summary

    Provides summary information about a document such as title, subject, author, company name, comments, etc. This information can be used later for identifying the document content. To specify one of the summary properties, an end-user should type the required text in the corresponding property field, as shown in the image at the beginning of the article.

  • Statistics

    Contains the automatically updated properties such as dates when the document was created, last modified, accessed or printed. In addition, this tab also displays the name of the user who last saved the document.

  • Custom

    This tab allows end-users to specify additional information about a workbook. To add a custom property, an end-user can select the required name from the list of suggested names, or type a new name in the Name field. In the Type drop-down list, a user can select the data type of the created property, and specify its value in the Value field.

    Checking the Link to content box enables the Source drop-down menu. In this menu, end-users can select the name of the cell or cell range to which the custom property should be linked. The linked custom property is marked with the SpreadsheetControl_DocumentProperties_Custom_LinkedIcon icon. If the custom property is linked to the named cell range, it gets the value of the range's upper-left cell.

    Clicking the Add button at the top-right corner of the dialog adds the specified property to the collection of custom properties.

    SpreadsheetControl_PropertiesDialogCustomTab

To provide end-users with the capability to invoke the Properties dialog, add the Info Ribbon page group to the SpreadsheetControl. For an example on how to create a Ribbon UI, refer to the Getting Started topic.

SpreadsheetControl_ DocPropertiesButton

To edit standard and custom document properties in code, use the IWorkbook.DocumentProperties property. For an example, refer to the How to: Specify Document Properties article.