Documentation

Class SettingsNode

Base class that support Clone() Clone and System.ComponentModel.INotifyPropertyChanged.

Inheritance
System.Object
Cloneable
SettingsNode
AggregateFunction
StringFormatSelector
DescriptionBase
Condition
GroupFilter
GroupComparer
ObjectComparer
TotalFormat
Inherited Members
Namespace: Telerik.Pivot.Core
Assembly: Telerik.Pivot.Core.dll

Syntax

public abstract class SettingsNode : Cloneable, INotifyPropertyChanged, ISupportInitialize, IObservableServiceProvider, IServiceProvider, IEditable

Constructors

SettingsNode()

Declaration
protected SettingsNode()

Properties

Parent

Gets the SettingsNode this SettingsNode is used in.

Declaration
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
protected void AddSettingsChild(SettingsNode child)
Parameters
SettingsNode child

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
public IDisposable BeginEdit()
Returns
System.IDisposable

An edit scope token that you must System.IDisposable.Dispose when you are done with the editing.
Implements

BeginInit()

Declaration
public void BeginInit()

EndInit()

Declaration
public void EndInit()

GetService(Type)

Declaration
public object GetService(Type serviceType)
Parameters
System.Type serviceType

Returns
System.Object

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 System.IServiceProvider would query the service on the local node and if not available would query up the Parent nodes.

Declaration
protected virtual object GetServiceOverride(Type serviceType)
Parameters
System.Type serviceType

The type of the requested service.
Returns
System.Object

A service instance if available, null otherwise.

NotifyServicesChanged()

Raises the ServicesChanged event.

Declaration
protected void NotifyServicesChanged()

NotifySettingsChanged(SettingsChangedEventArgs)

Will recursively notify all SettingsNode for a settings change.

Declaration
protected void NotifySettingsChanged(SettingsChangedEventArgs args)
Parameters
SettingsChangedEventArgs args

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
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
protected virtual void OnExitingEditScope()

OnPropertyChanged(String)

Raises this object's PropertyChanged event.

Declaration
protected void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

The property that has a new value.

OnSettingsChanged(SettingsChangedEventArgs)

Invoked when a SettingsChangedEventArgs reaches the SettingsNode.

Declaration
protected virtual void OnSettingsChanged(SettingsChangedEventArgs args)
Parameters
SettingsChangedEventArgs args

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
protected void RemoveSettingsChild(SettingsNode child)
Parameters
SettingsNode child

The nested SettingsNode.

Events

PropertyChanged

Invoked when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

ServicesChanged

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

Declaration
public event EventHandler<EventArgs> ServicesChanged
Event Type
System.EventHandler<System.EventArgs>

SettingsChanged

Invoked when this or one of the children is changed.

Declaration
public event EventHandler<SettingsChangedEventArgs> SettingsChanged
Event Type
System.EventHandler<SettingsChangedEventArgs>

Extension Methods