The DocumentProperties Object
(SADocumentProperties)

[VBScript]
Property Application As String (read-only)

When ExcelWriter saves a generated spreadsheet, Application is set to "SoftArtisans ExcelWriter." Application a Read Only property.

[VBScript]
Property Author As String (read/write)

Author sets or returns a spreadsheet's author. In Microsoft Excel, the value of the Author property is displayed on the Summary page of the spreadsheet's Properties sheet. To see Excel's Author field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

Excel allows you to search for a file by author:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Author.
4. In the Value text box, enter the author.
5. Set other search options.
6. Click Search.

Author is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Author = "John Smith"

[VBScript]
Property Category As String (read/write)

Category sets or returns the value of a spreadsheet's Category field in Microsoft Excel. To see Excel's Category field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

You can set Category to group files together. This allows you to search for files according to category:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Category.
4. In the Value text box, enter a category.
5. Set other search options.
6. Click Search.

Category is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Category = "Invoice"

[VBScript]
Property Comments As String (read/write)

Comments sets or returns the value of a spreadsheet's Comments field in Microsoft Excel. To see Excel Comments field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

In Excel, you can use the Comments field to search for files:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Comments.
4. In the Value text box, enter the comments to search for.
5. Set other search options.
6. Click Search.

Comments is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Comments = "Generated by ExcelWriter"

[VBScript]
Property Company As String (read/write)

Company sets or returns the company name displayed in a spreadsheet's Company field in Microsoft Excel. To see Excel's Company field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

Excel allows you to search for files by company:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Company.
4. In the Value text box, enter a company name to search for.
5. Set other search options.
6. Click Search.

Company is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Company = "SoftArtisans"

[VBScript]
Property CreationDate As Variant (read/write)

CreationDate sets or returns the creation date of the specified spreadsheet. By default, CreationDate returns the spreadsheet's actual creation date. You can set CreationDate to a different date, but this will not change the creation date displayed in the spreadsheet's Properties sheet.

While setting CreationDate will not change the creation date in the file's Properties sheet, you can use the date you set to search for a file by creation date:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select CreationDate.
4. From the Condition list, select a condition.
5. In the Value text box, enter the date to search for.
6. Set other search options.
7. Click Search.

CreationDate is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.CreationDate = "12/20/2003"

[VBScript]
Property Keywords As String (read/write)

Keywords sets or returns keywords that can be used to search for the specified spreadsheet. In Excel, a file's keywords are displayed in the Summary page of the Properties sheet. To see the Keywords field in Excel:

1. Open Excel's File menu.
2. Select Properties.
3. Select the Summary tab.

To search for files using a keyword:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Keywords.
4. From the Condition list, select a condition.
5. In the Value text box, enter a keyword to search for.
6. Set other search options.
7. Click Search.

Keywords is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Keywords = "ExcelWriter, WordWriter, OfficeWriter"

[VBScript]
Property LastSavedBy As String (read/write)

LastSavedBy sets or returns the name of the last person that saved the current spreadsheet. In Excel, a file's Last saved by field is displayed in the Statistics page of the file's Properties sheet. To see the field in Excel:

1. Open Excel's File menu.
2. Select Properties.
3. Select the Statistics tab.

You can use the value of LastSavedBy to search for a files:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Last saved by.
4. From the Condition list, select a condition.
5. In the Value text box, enter the date to search for.
6. Set other search options.
7. Click Search.

LastSavedBy is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.LastSavedBy = "Jane"

[VBScript]
Property LastSavedDate As Variant (read/write)

LastSavedDate sets or returns the date on which the current spreadsheet was last saved. LastSavedDate is not set by default, is not displayed in the spreadsheet's Properties sheet, and cannot be used to search for a file.

LastSavedDate is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.LastSavedDate = "12/20/2003"

[VBScript]
Property LinksUpToDate As Boolean (read/write)

The value of LinksUpToDate specifies whether or not the hyperlinks in the spreadsheet are up-to-date. Set LinksUpToDate to true to indicate that the links are up-to-date, and set the property to false to indicate that the links are not up-to-date. LinksUpToDate is set to false by default.

LinksUpToDate is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.LinksUpToDate = true

[VBScript]
Property Manager As String (read/write)

Manager sets or returns the value of a spreadsheet's Manager field in Microsoft Excel. To see Excel's Manager field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

Excel allows you to search for a files by manager:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Manager.
4. In the Value text box, enter the manager name to search for.
5. Set other search options.
6. Click Search.

Manager is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Manager = "John Smith"

[VBScript]
Property RevisionNumber As String (read/write)

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.RevisionNumber = "7"

[VBScript]
Property ScaleCrop As Boolean (read/write)

ScaleCrop sets or returns a value that indicates whether scaling or cropping is desired. Set ScaleCrop to true when scaling of the thumbnail is desired. Set ScaleCrop to false when cropping is desired.

ScaleCrop is a Read/Write property and is set to true by default.

[VBScript]
Property Subject As String (read/write)

Subject sets or returns the value of a spreadsheet's Subject field in Microsoft Excel. To see Excel's Subject field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

You can set Subject to group files together. This allows you to search for files according to subject:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Subject.
4. In the Value text box, enter a subject.
5. Set other search options.
6. Click Search.

Subject is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Subject = "Web reporting solutions"

[VBScript]
Property Title As String (read/write)

Title sets or returns the value of a spreadsheet's Title field in Microsoft Excel. To see Excel's Title field:

1. In Excel, open the File menu.
2. Select Properties.
3. Select the Summary tab.

Excel allows you to search for a files by title:

1. In Excel, click the Search button.
   
   
   
   
2. Click Advanced Search.
3. From the Property drop-down list, select Title.
4. In the Value text box, enter a title.
5. Set other search options.
6. Click Search.

Title is a Read/Write property.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Title = "SoftArtisans OfficeWriter"

[VBScript]
Sub Clear()

Clear clears most of the fields in the current spreadsheet's Properties sheet. To see a file's Properties sheet:

1. In Excel, open the File menu.
2. Select Properties.

Set DocProperties = ExcelApplication.DocumentProperties
DocProperties.Clear