Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Description

Excerpt

The DocumentProperties object represents properties of a spreadsheet.

  • In Excel 2003 these properties can be accessed via (File -> Properties).
  • In Excel 2007 they can be accessed via (Ribbon button -> Prepare -> Properties).
  • In Excel 2010 they can be accessed via (File -> Info -> Show All Properties on the right).
  • In Windows Explorer, right-click on the file and select 'Properties'.

The DocumentProperties class can be used to remove personal information from an existing spreadsheet, or to populate searchable fields that can be used to locate the file.

Signature
C#
C#
[DefaultMember("Item")]
 public sealed class DocumentProperties
{signature}{signature:
}
Signature
vb.net
vb.net
<DefaultMember("Item")> _
	Public NotInheritable Class DocumentProperties
{signature}
{remarks}To return a {{DocumentProperties}} object, use [
Remarks

To return a DocumentProperties object, use Workbook.DocumentProperties

|Workbook.DocumentProperties]. {remarks} {example}{code:csharp|title=C#}

.

Example
Code Block
csharp
csharp
titleC#


          ExcelApplication xla = new ExcelApplication();
          Workbook wb = xla.Create();
          DocumentProperties docProps = wb.DocumentProperties;
        
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}


          Dim xla As New ExcelApplication()
          Dim wb As Workbook = xla.Create()
          Dim docProps = wb.DocumentProperties
        
{code} {example} {properties} ||Name||Description|| |[Application|DocumentProperties.Application]|{excerpt-include:DocumentProperties.Application|nopanel=true}| |[Author|DocumentProperties.Author]|{excerpt-include:DocumentProperties.Author|nopanel=true}| |[Category|DocumentProperties.Category]|{excerpt-include:DocumentProperties.Category|nopanel=true}| |[Comments|DocumentProperties.Comments]|{excerpt-include:DocumentProperties.Comments|nopanel=true}| |[Company|DocumentProperties.Company]|{excerpt-include:DocumentProperties.Company|nopanel=true}| |[CreationDate|DocumentProperties.CreationDate]|{excerpt-include:DocumentProperties.CreationDate|nopanel=true}| |[Keywords|DocumentProperties.Keywords]|{excerpt-include:DocumentProperties.Keywords|nopanel=true}| |[LastSavedDate|DocumentProperties.LastSavedDate]|{excerpt-include:DocumentProperties.LastSavedDate|nopanel=true}| |[Manager|DocumentProperties.Manager]|{excerpt-include:DocumentProperties.Manager|nopanel=true}| |[Title|DocumentProperties.Title]|{excerpt-include:DocumentProperties.Title|nopanel=true}| {indexers} ||Name||Description|| |[Item(DocumentProperties.BuiltIn)|
Properties

Name

Description

Application

Excerpt Include
DocumentProperties.Application
DocumentProperties.Application
nopaneltrue

Author

Excerpt Include
DocumentProperties.Author
DocumentProperties.Author
nopaneltrue

Category

Excerpt Include
DocumentProperties.Category
DocumentProperties.Category
nopaneltrue

Comments

Excerpt Include
DocumentProperties.Comments
DocumentProperties.Comments
nopaneltrue

Company

Excerpt Include
DocumentProperties.Company
DocumentProperties.Company
nopaneltrue

CreationDate

Excerpt Include
DocumentProperties.CreationDate
DocumentProperties.CreationDate
nopaneltrue

Keywords

Excerpt Include
DocumentProperties.Keywords
DocumentProperties.Keywords
nopaneltrue

LastSavedDate

Excerpt Include
DocumentProperties.LastSavedDate
DocumentProperties.LastSavedDate
nopaneltrue

Manager

Excerpt Include
DocumentProperties.Manager
DocumentProperties.Manager
nopaneltrue

Title

Excerpt Include
DocumentProperties.Title
DocumentProperties.Title
nopaneltrue
Indexers

Name

Description

Item(DocumentProperties.BuiltIn)

Excerpt Include
DocumentProperties.Item(DocumentProperties.BuiltIn)

...

DocumentProperties.Item(DocumentProperties.BuiltIn)

...

nopanel

...

...

Excerpt Include
DocumentProperties.Item(String)

...

DocumentProperties.Item(String)

...

nopanel

...

true
Methods

Name

Description

Clear()

Excerpt Include
DocumentProperties.Clear()

...

DocumentProperties.Clear()

...

nopanel

...

...

Excerpt Include
DocumentProperties.GetCustomProperty(String)

...

DocumentProperties.GetCustomProperty(String)

...

nopanel

...

...

Excerpt Include
DocumentProperties.RestoreDefaults()

...

DocumentProperties.RestoreDefaults()

...

nopanel

...

...

...

Excerpt Include
DocumentProperties.SetCustomProperty(String,

...

Object)

...

DocumentProperties.SetCustomProperty(String,

...

Object)

...

nopanel

...

true
Classes

Name

Description

BuiltIn

Excerpt Include
DocumentProperties.BuiltIn
DocumentProperties.BuiltIn
nopaneltrue