Class
SettingsNode

Base class that support Clone() Clone and INotifyPropertyChanged.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[DataContract]
public abstract class SettingsNode : Cloneable, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable

Inheritance: objectCloneableSettingsNode

Derived Classes: AggregateFunctionStringFormatSelectorDescriptionBaseConditionGroupFilterGroupComparerObjectComparerTotalFormat

Implements: IEditableINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members Cloneable.Clone()Cloneable.CreateInstanceCore()Cloneable.CloneCore(Cloneable)

Constructors

SettingsNode()

Declaration

cs-api-definition
protected SettingsNode()

Properties

Parent

Gets the SettingsNode this SettingsNode is used in.

Declaration

cs-api-definition
public SettingsNode Parent { get; }

Property Value

SettingsNode

Methods

AddSettingsChild(SettingsNode)

Set this SettingsNode as parent of the child and becomes a target for the child's change notifications.

Declaration

cs-api-definition
protected void AddSettingsChild(SettingsNode child)

Parameters

child

SettingsNode

The nested SettingsNode.

BeginEdit()

Enters the SettingsNode in a new editing scope. Use when applying multiple changes. If child SettingsNode are changed, notifications will be accumulated in this SettingsNode. using(settingsNode.BeginEdit()) { // Apply multiple changes here. }

Declaration

cs-api-definition
public IDisposable BeginEdit()

Returns

IDisposable

An edit scope token that you must Dispose() when you are done with the editing.

Implements IEditable.BeginEdit()

BeginInit()

Declaration

cs-api-definition
public void BeginInit()

Implements ISupportInitialize.BeginInit()

EndInit()

Declaration

cs-api-definition
public void EndInit()

Implements ISupportInitialize.EndInit()

GetService(Type)

Declaration

cs-api-definition
public object GetService(Type serviceType)

Parameters

serviceType

Type

Returns

object

Implements IServiceProvider.GetService(Type)

GetServiceOverride(Type)

Provides services available by this SettingsNode. Other services may be available in its Parent SettingsNodes. The default implementation returns this SettingsNode if the desired service type is assignable from the type of this. The GetService(Type) implementation of IServiceProvider would query the service on the local node and if not available would query up the Parent nodes.

Declaration

cs-api-definition
protected virtual object GetServiceOverride(Type serviceType)

Parameters

serviceType

Type

The type of the requested service.

Returns

object

A service instance if available, null otherwise.

NotifyServicesChanged()

Raises the ServicesChanged event.

Declaration

cs-api-definition
protected void NotifyServicesChanged()

NotifySettingsChanged(SettingsChangedEventArgs)

Will recursively notify all SettingsNode for a settings change.

Declaration

cs-api-definition
protected void NotifySettingsChanged(SettingsChangedEventArgs args)

Parameters

args

SettingsChangedEventArgs

SettingsChangedEventArgs that contain information about the change.

OnEnteredEditScope()

Override to provide custom behavior for derived classes when editing begins. SettingsNode is already in edit mode and changes within the method body will be accumulated and released upon exit.

Declaration

cs-api-definition
protected virtual void OnEnteredEditScope()

OnExitingEditScope()

Override to provide custom behavior for derived classes when finishing editing. SettingsNode is still in edit mode and changes within the method body will be accumulated and released upon exit.

Declaration

cs-api-definition
protected virtual void OnExitingEditScope()

OnPropertyChanged(string)

Raises this object's PropertyChanged event.

Declaration

cs-api-definition
protected void OnPropertyChanged(string propertyName)

Parameters

propertyName

string

The property that has a new value.

OnSettingsChanged(SettingsChangedEventArgs)

Invoked when a SettingsChangedEventArgs reaches the SettingsNode.

Declaration

cs-api-definition
protected virtual void OnSettingsChanged(SettingsChangedEventArgs args)

Parameters

args

SettingsChangedEventArgs

The SettingsChangedEventArgs that contains the event data.

RemoveSettingsChild(SettingsNode)

Unsets the parent initiated with AddSettingsChild(SettingsNode). This SettingsNode will no longer receive change notifications from the child.

Declaration

cs-api-definition
protected void RemoveSettingsChild(SettingsNode child)

Parameters

child

SettingsNode

The nested SettingsNode.

Events

PropertyChanged

Invoked when a property value changes.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged

ServicesChanged

Invoked when new services are available or existing services are removed.

Declaration

cs-api-definition
public event EventHandler<EventArgs> ServicesChanged

Event Value

EventHandler<EventArgs>

SettingsChanged

Invoked when this or one of the children is changed.

Declaration

cs-api-definition
public event EventHandler<SettingsChangedEventArgs> SettingsChanged

Event Value

EventHandler<SettingsChangedEventArgs>