DocumentCustomProperties.Clear() Method

Removes all the custom document properties from a workbook.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

void Clear()

VB.NET

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

The example below demonstrates how to remove all the custom document properties from a workbook.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-part-2-e4832

DocumentPropertiesActions.vb

' Remove all custom document properties.
workbook.DocumentProperties.Custom.Clear()

DocumentPropertiesActions.cs

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