Class DescriptorBase

Base class for schema definition objects of the grouping engine.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
DescriptorBase
Engine
FieldDescriptor
FilterCondition
RecordFilterDescriptor
RelationDescriptor
RelationKeyDescriptor
SortColumnDescriptor
SourceListDescriptor
SummaryDescriptor
ConditionalFormatRuleBase
GridColumnDescriptor
GridColumnSetDescriptor
GridColumnSpanDescriptor
GridConditionalFormatDescriptor
GridPropertyTypeDefaultStyle
GridStackedHeaderDescriptor
GridStackedHeaderRowDescriptor
GridStackedHeaderVisibleColumnDescriptor
GridSummaryColumnDescriptor
GridSummaryRowDescriptor
GridTableBaseStyle
GridVisibleColumnDescriptor
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public abstract class DescriptorBase : ShouldSerializeBasedPersisterType, ICustomTypeDescriptor, IDisposable

Constructors

DescriptorBase()

Declaration
protected DescriptorBase()

Properties

Disposing

Returns True if object is executing the Dispose(Boolean) method call.

Declaration
public bool Disposing { get; }
Property Value
Type
System.Boolean

InDisposed

Returns after object was disposed and object is executing the Disposed event.

Declaration
public bool InDisposed { get; }
Property Value
Type
System.Boolean

IsDisposed

Gets if object has been disposed.

Declaration
public bool IsDisposed { get; }
Property Value
Type
System.Boolean

Methods

CanResetValue()

The framework calls this method to determine whether calling Reset will have any effect.

Declaration
public virtual bool CanResetValue()
Returns
Type Description
System.Boolean

True if Reset can be called; False otherwise.

Dispose()

Disposes the object.

Declaration
public void Dispose()

Dispose(Boolean)

Called to clean up state of this object when it is disposed.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

True if called from Dispose(Boolean); False if called from Finalizes.

GetName()

The framework calls this method to determine the name of this object.

Declaration
public abstract string GetName()
Returns
Type Description
System.String

Object name.

OnDisposed(EventArgs)

Raises the Disposed event.

Declaration
protected virtual void OnDisposed(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains the event data.

Reset()

The framework calls this method to reset the object back to its default state.

Declaration
public virtual void Reset()

ShouldSerialize()

The framework calls this method to determine whether properties or child objects of this object should be serialized. (Code serialization and / or XML Serialization).

Declaration
public virtual bool ShouldSerialize()
Returns
Type Description
System.Boolean

True if the object should be serialized; False otherwise.

ToString()

Returns string representation of the DescriptorBase object.

Declaration
public override string ToString()
Returns
Type Description
System.String

String representation of the current object.
Overrides
System.Object.ToString()

Events

Disposed

Occurs after the object was disposed.

Declaration
public event EventHandler Disposed
Event Type
Type
System.EventHandler

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable