Back to Devexpress

DocumentCustomProperties.Clear() Method

officefileapi-devexpress-dot-spreadsheet-dot-documentcustomproperties.md

latest2.7 KB
Original Source

DocumentCustomProperties.Clear() Method

Removes all the custom document properties from a workbook.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
void Clear()
vb
Sub Clear

Remarks

Use the Clear method to delete all user defined properties from a workbook. To remove an individual custom document property, get access to this property by its name (using the DocumentCustomProperties.Item property) and set it to null ( Nothing in VB).

Example

View Example

csharp
// Remove all custom document properties.
workbook.DocumentProperties.Custom.Clear();
vb
' Remove all custom document properties.
workbook.DocumentProperties.Custom.Clear()

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

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.

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/DocumentPropertiesActions.vb#L89

vb
#End Region ' #ClearCustomProperties
                workbook.DocumentProperties.Custom.Clear()
            Finally

See Also

DocumentCustomProperties Interface

DocumentCustomProperties Members

DevExpress.Spreadsheet Namespace