Search Results for

    Show / Hide Table of Contents

    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
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget
    %s requires a valid license key for further deployment. Get Trial Below.
    ironsuite
    Blue key in circleGet Started for Free
    30 days full access • No credit card required
    Test in a live environment

    Test in production without watermarks.
    Works wherever you need it to.

    Fully-functional product

    Get 30 days of fully functional product.
    Have it up and running in minutes.

    24/5 technical support

    Full access to our support engineering team during your product trial

    Grey key in circleGet Started for Free
    The trial form was submitted successfully.
    Grey check in circleTrial key delivered
    Your key has been issued and sent to your email.
    Calendar in circleBook Free Live Demo
    No cards • no pitches • no commitments Pick a time for a quick, personalized demo
    Get the most out of your 30-day trial with:

    Live product and key features walk-through

    Project-specific recommendations

    All your questions answered

    Grey key in circleBook Free Live Demo
    Your booking has been completed Check your e-mail for confirmation

    Want to deploy Iron Suite
    to a live project for FREE?

    What’s included?

    • Test in production without watermarks
    • 30 days fully functional product
    • 24/5 technical support during trial
    ironpdf Logo
    ironword Logo
    ironxl Logo
    ironppt Logo
    ironocr Logo
    ironbarcode Logo
    ironqr Logo
    ironprint Logo
    ironzip Logo
    ironwebscraper Logo
    Iron Software sales team
    Online 24/5
    Have Enterprise licensing requirements?
    Request Iron Suite Enterprise trial
    Key in blue circle

    Get your free 30-day Trial Key instantly

    Your trial license will be sent to your email address

    No limitations. 100% unlocked. No credit card.

    bullet_checkedNo credit card or account creation requiredNo limitations. 100% unlocked. No credit card.
    Or
    Key in blue circle

    Complete Your Trial Key Signup

    Tell us a little more about yourself.

    Key in blue circleNo credit card or account creation requiredNo limitations. 100% unlocked. No credit card.
    Key in blue circle

    Your license key has been delivered to your inbox

    Can't find it? Check your spam folder.

    What’s next?
    Install with NuGet
    Add IronXL to your project
    Quickstart Guide
    Helpful resources to get started

    Need help getting started?

    Book a Free Live Demo

    See IronXL in action and get your licensing questions answered, or

    Key in blue circle

    Your demo request is in.

    You'll receive an invite via email shortly.

    What’s next?
    Explore Documentation
    Review Licensing Options
    badge_greencheck_in_yellowcircle
    Thank you
    Your trial key should be in the email.
    If it is not, please contact support@ironsoftware.com
    • Logo Aetna
    • Logo NASA
    • Logo GE
    • Logo Porsche
    • Logo USDA
    • Logo Qatar
    Join Millions of Engineers who’ve tried IronXL
    Your trial key should be in the email.
    If it is not, please contact support@ironsoftware.com