XlDocumentProperties.Title Property

Gets or sets the title of the document.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public string Title { get; set; }

VB.NET

Public Property Title As String

Property Value

Type	Description
String	A String value that is the document’s title.

Example

This example demonstrates how to specify the standard and custom document properties for a workbook using the IXlDocument.Properties and XlDocumentProperties.Custom properties, respectively.

Use the IXlDocument.Properties property to access the XlDocumentProperties object. This object provides a set of properties that allow you to specify basic information about a workbook, such as XlDocumentProperties.Title, XlDocumentProperties.Author, XlDocumentProperties.Subject, etc.

The XlDocumentProperties.Custom property allows you to get access to the XlDocumentCustomProperties object, which represents a storage of custom document properties. To set a value of a custom property with the specified name, use the XlDocumentCustomProperties.Item property. You can set a custom property to any object of the String, Double, DateTime or Boolean type. The specified object will be converted to the XlCustomPropertyValue object and assigned to the custom property. To get the type of the data contained in a custom document property, use the XlCustomPropertyValue.Type property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/excel-export-api-examples

MiscellaneousActions.cs

// Create a new document.
using (IXlDocument document = exporter.CreateDocument(stream)) {
    document.Options.Culture = CultureInfo.CurrentCulture;

    // Set the built-in document properties.
    document.Properties.Title = "XL Export API: document properties example";
    document.Properties.Subject = "XL Export API";
    document.Properties.Keywords = "XL Export, document generation";
    document.Properties.Description = "How to set document properties using the XL Export API";
    document.Properties.Category = "Spreadsheet";
    document.Properties.Company = "DevExpress Inc.";

    // Set the custom document properties.
    document.Properties.Custom["Product Suite"] = "XL Export Library";
    document.Properties.Custom["Revision"] = 5;
    document.Properties.Custom["Date Completed"] = DateTime.Now;
    document.Properties.Custom["Published"] = true;

    // Generate data for the document.
    using(IXlSheet sheet = document.CreateSheet()) {
        sheet.SkipRows(1);
        using(IXlRow row = sheet.CreateRow()) {
            row.SkipCells(1);
            using(IXlCell cell = row.CreateCell()) {
                cell.Value = "You can view document properties using the File->Info->Properties->Advanced Properties dialog.";
            }
        }
    }
}

MiscellaneousActions.vb

' Create a new document.
Using document As IXlDocument = exporter.CreateDocument(stream)
    document.Options.Culture = CultureInfo.CurrentCulture

    ' Set the built-in document properties.
    document.Properties.Title = "XL Export API: document properties example"
    document.Properties.Subject = "XL Export API"
    document.Properties.Keywords = "XL Export, document generation"
    document.Properties.Description = "How to set document properties using the XL Export API"
    document.Properties.Category = "Spreadsheet"
    document.Properties.Company = "DevExpress Inc."

    ' Set the custom document properties.
    document.Properties.Custom("Product Suite") = "XL Export Library"
    document.Properties.Custom("Revision") = 5
    document.Properties.Custom("Date Completed") = Date.Now
    document.Properties.Custom("Published") = True

    ' Generate data for the document.
    Using sheet As IXlSheet = document.CreateSheet()
        sheet.SkipRows(1)
        Using row As IXlRow = sheet.CreateRow()
            row.SkipCells(1)
            Using cell As IXlCell = row.CreateCell()
                cell.Value = "You can view document properties using the File->Info->Properties->Advanced Properties dialog."
            End Using
        End Using
    End Using
End Using

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Title property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

excel-export-api-examples/CS/XLExportExamples/SpreadsheetActions/MiscellaneousActions.cs#L84

// Set the built-in document properties.
document.Properties.Title = "XL Export API: document properties example";
document.Properties.Subject = "XL Export API";

VB.NET

excel-export-api-examples/VB/XLExportExamples/SpreadsheetActions/MiscellaneousActions.vb#L87

' Set the built-in document properties.
document.Properties.Title = "XL Export API: document properties example"
document.Properties.Subject = "XL Export API"