Interface IMetadata
Interface that represents meta-data for the Excel file such as "Author", "Title"...
Namespace: IronXL.Metadata
Assembly: IronXL.dll
Syntax
public interface IMetadata
Document-level details for a spreadsheet, including author, title, subject, keywords, and the dates a file was created or modified, live on IMetadata. A developer reads and writes these properties to stamp a workbook with authorship before it ships, to populate the descriptive fields a document-management system indexes, or to audit who and when a file reports. It is the contract that surfaces the same information Excel shows under File then Info, made available to code rather than the desktop dialog. Where ICustomProperties holds arbitrary application-defined key/value pairs, IMetadata covers the fixed, well-known fields every Office document carries.
A developer obtains an IMetadata from the workbook itself: WorkBook.Metadata returns the instance for the open file. There is no constructor to call, because the metadata always belongs to a specific workbook, and editing it in place is how changes are recorded. The values written through this contract are saved when the workbook is saved, so a typical flow loads or creates a WorkBook, sets the metadata fields, and writes the file out.
The writable fields cover the descriptive surface: Author, Title, Subject, Keywords, and Comments are the everyday ones, while Category and the nullable Created, Modified, and LastPrinted dates record classification and history. A few fields are read-only and reflect the originating application rather than developer input: Company, Manager, Template, and ApplicationName expose values without a setter. The CustomProperties property returns an ICustomProperties for any field outside this fixed set. Setting Author and Title before saving is the most common task; the nullable date fields accept a DateTime or stay unset.
IMetadata metadata = workbook.Metadata;
metadata.Author = "Iron Software";
metadata.Title = "Quarterly Report";The edit Excel metadata example sets the descriptive fields, the edit workbook metadata how-to walks through reading and updating them, and the ICustomProperties reference covers application-defined fields beyond the fixed set.
Properties
ApplicationName
Gets the name of the application with which the file was created.
Declaration
string ApplicationName { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Author
Gets or sets the author of the file.
Declaration
string Author { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Category
Gets or sets the category of the file.
Declaration
string Category { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Comments
Gets or sets the comments field value.
Declaration
string Comments { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Company
Gets the company field value.
Declaration
string Company { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Created
Gets or sets the creation time.
Declaration
Nullable<DateTime> Created { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
CustomProperties
Gets the custom properties of the workbook.
Declaration
ICustomProperties CustomProperties { get; }
Property Value
| Type | Description |
|---|---|
| ICustomProperties |
Keywords
Gets or sets the keywords field value.
Declaration
string Keywords { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
LastPrinted
Gets or sets the last printed time.
Declaration
Nullable<DateTime> LastPrinted { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
Manager
Gets the manager field value.
Declaration
string Manager { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Modified
Gets or sets the last modification time.
Declaration
Nullable<DateTime> Modified { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
Subject
Gets or sets the subject of the file.
Declaration
string Subject { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Template
Gets the template field value.
Declaration
string Template { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Title
Gets or sets the title of the file.
Declaration
string Title { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |