| Revit 2023 API |
| Entity..::..Clear Method (Field) |
| Entity Class See Also |
Resets the field to its default value.
Namespace: Autodesk.Revit.DB.ExtensibleStorage
Assembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since:
2012
Syntax
| C# |
|---|
public void Clear( Field field ) |
| Visual Basic |
|---|
Public Sub Clear ( _ field As Field _ ) |
| Visual C++ |
|---|
public: void Clear( Field^ field ) |
Parameters
- field
- Type: Autodesk.Revit.DB.ExtensibleStorage..::..Field
The field to clear.
Remarks
The default value is zero for numeric fields, invalid value for identifiers and
entities, and empty for strings and containers.
Exceptions
| Exception | Condition |
|---|---|
| Autodesk.Revit.Exceptions..::..ArgumentException | The Field belongs to a different Schema from this Entity, or this Entity is invalid. -or- This field's subschema prevents writing. |
| Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was null |