Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
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.

|Workbook.DocumentProperties].

{remarks}
{example}{code:csharp|title=C#}

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

          Dim xla As New ExcelApplication()
          Dim wb As Workbook = xla.Create()
          Dim docProps = wb.DocumentProperties
        
Signature
C#C#
Wiki Markup
{description}
{excerpt}The [DocumentProperties|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.{excerpt}
{signature:C#}
[DefaultMember("Item")]
 public sealed class DocumentProperties
Signature
{signature}{signature:vb.net
vb.net
}
<DefaultMember("Item")> _
	Public NotInheritable Class DocumentProperties
Remarks
To return a DocumentProperties object, use
{signature}
{remarks}To return a {{DocumentProperties}} object, use [Workbook.DocumentProperties
.
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle
Properties

...

Name

...

Description

...

Application

...

{code}

{example}
{properties}
||Name||Description||
|[Application|DocumentProperties.Application]|{excerpt-include:DocumentProperties.Application

...

Author

|nopanel=true}|
|[Author|DocumentProperties.Author]|{excerpt-include

...

:DocumentProperties.Author

...

Category

|nopanel=true}|
|[Category|DocumentProperties.Category]|{excerpt-include

...

:DocumentProperties.Category

...

Comments

|nopanel=true}|
|[Comments|DocumentProperties.Comments]|{excerpt-include

...

:DocumentProperties.Comments

...

Company

|nopanel=true}|
|[Company|DocumentProperties.Company]|{excerpt-include

...

:DocumentProperties.Company

...

CreationDate

|nopanel=true}|
|[CreationDate|DocumentProperties.CreationDate]|{excerpt-include

...

:DocumentProperties.CreationDate

...

Keywords

|nopanel=true}|
|[Keywords|DocumentProperties.Keywords]|{excerpt-include

...

:DocumentProperties.Keywords

...

LastSavedDate

|nopanel=true}|
|[LastSavedDate|DocumentProperties.LastSavedDate]|{excerpt-include

...

:DocumentProperties.LastSavedDate

...

Manager

|nopanel=true}|
|[Manager|DocumentProperties.Manager]|{excerpt-include

...

:DocumentProperties.Manager

...

Title

|nopanel=true}|
|[Title|DocumentProperties.Title]|{excerpt-include

...

:DocumentProperties.Title

...

Indexers

...

Name

...

Description

|nopanel=true}|
{indexers}
||Name||Description||
|[Item(DocumentProperties.BuiltIn)

...

|DocumentProperties.Item(DocumentProperties.BuiltIn)

...

]|{excerpt-include:DocumentProperties.Item(DocumentProperties.BuiltIn)

...

|nopanel

...

=true}|
|[Item(String)

...

|DocumentProperties.Item(String)

...

]|{excerpt-include:DocumentProperties.Item(String)

...

|nopanel

...

Methods

...

Name

...

Description

...

Clear()

...

=true}|
{methods}
||Name||Description||
|[Clear()|DocumentProperties.Clear()

...

]|{excerpt-include:DocumentProperties.Clear()

...

|nopanel

...

=true}|
|[GetCustomProperty(String)

...

|DocumentProperties.GetCustomProperty(String)

...

]|{excerpt-include:DocumentProperties.GetCustomProperty(String)

...

|nopanel

...

=true}|
|[RestoreDefaults()

...

|DocumentProperties.RestoreDefaults()

...

]|{excerpt-include:DocumentProperties.RestoreDefaults()

...

|nopanel

...

=true}|
|[SetCustomProperty(String, Object)

...

|DocumentProperties.SetCustomProperty(String, Object)

...

]|{excerpt-include:DocumentProperties.SetCustomProperty(String, Object)

...

|nopanel

...

Classes

...

Name

...

Description

...

BuiltIn

...

=true}|
{classes}
||Name||Description||
|[BuiltIn|DocumentProperties.BuiltIn]|{excerpt-include:DocumentProperties.BuiltIn

...

|nopanel=true}|