Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Description

Excerpt

This class contains all file properties that are used by Word and Windows Explorer to display and store metadata about documents. None of these properties will affect the content of a document.

Signature
C#C#
Wiki Markup
{description}
{excerpt}This class contains all file properties that are used by Word and Windows Explorer to display and store metadata about documents. None of these properties will affect the content of a document.{excerpt}
{signature:C#}
 public sealed class DocumentProperties
Signature
{signature}{signature:vb.net
vb.net
}
Public NotInheritable Class DocumentProperties
Remarks

You cannot create a DocumentProperties object using the new keyword. You must get an existing DocumentProperties object from a Document.

MS Word equivalent: File menu > Properties

The following sample gets the DocumentProperties of a document so you can start working with these properties.

{signature}
{remarks}You cannot create a [DocumentProperties|DocumentProperties] object using the {{new}} keyword. You must get an existing {{DocumentProperties}} object from a [Document|Document].

MS Word equivalent: File menu > Properties

The following sample gets the DocumentProperties of a document so you can start working with these properties.

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

          WordApplication app = new WordApplication();
          Document doc = app.Create();
          DocumentProperties docProps = doc.DocumentProperties;
        
{code}
{code:vb.net
|title=vb.net
}

          Dim app As New WordApplication()
          Dim doc As Document = app.Create()
          Dim docProps As DocumentProperties = doc.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

...

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

...

Subject

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

...

:DocumentProperties.Subject

...

Title

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

...

:DocumentProperties.Title

...

Methods

...

Name

...

Description

...

Clear()

...

|nopanel=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}|
|[GetProperty(DocumentProperties.BuiltInProperty)

...

|DocumentProperties.GetProperty(DocumentProperties.BuiltInProperty)

...

]|{excerpt-include:DocumentProperties.GetProperty(DocumentProperties.BuiltInProperty)

...

|nopanel

...

=true}|
|[GetProperty(String)

...

|DocumentProperties.GetProperty(String)

...

]|{excerpt-include:DocumentProperties.GetProperty(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

...

=true}|
|[SetProperty(DocumentProperties.BuiltInProperty, Object)

...

|DocumentProperties.SetProperty(DocumentProperties.BuiltInProperty, Object)

...

]|{excerpt-include:DocumentProperties.SetProperty(DocumentProperties.BuiltInProperty, Object)

...

|nopanel

...

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

...

|DocumentProperties.SetProperty(String, Object)

...

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

...

|nopanel

...

Classes

...

Name

...

Description

...

BuiltInProperty

...

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

...

|nopanel=true}|