Class
ScopeFlag

Represents a flag within the scope of Telerik's control architecture, providing an enumeration of possible states or behaviors.

Definition

Namespace:Telerik.Windows.Controls.Scopes

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1726:UsePreferredTerms", MessageId = "Flag")]
public abstract class ScopeFlag : IScopeFlag

Inheritance: objectScopeFlag

Derived Classes: NestedScopeFlagSingleScopeFlag

Implements: IScopeFlag

Constructors

ScopeFlag()

Declaration

cs-api-definition
protected ScopeFlag()

Properties

CancelScopeCallback

Represents a callback function that is invoked when a cancel scope event occurs.

Declaration

cs-api-definition
public Action CancelScopeCallback { get; set; }

Property Value

Action

CloseScopeCallback

Represents a callback function that is invoked when a scope is closed.

Declaration

cs-api-definition
public Action CloseScopeCallback { get; set; }

Property Value

Action

IsActive

Gets a value indicating whether the scope flag is currently active.

Declaration

cs-api-definition
public abstract bool IsActive { get; }

Property Value

bool

A boolean value that indicates the active state of the scope flag.

Implements IScopeFlag.IsActive

ThrowOnError

Defines the error handling behavior for the ScopeFlag. When set to true, exceptions will be thrown when an error occurs; otherwise, errors will be handled silently.

Declaration

cs-api-definition
public bool ThrowOnError { get; set; }

Property Value

bool

Returns the current instance of ScopeFlag for method chaining.

Methods

BeginScope()

Begins a new scope within the current context, allowing for scoped operations.

Declaration

cs-api-definition
public IDisposable BeginScope()

Returns

IDisposable

A ScopeFlag that represents the newly created scope.

Implements IScopeFlag.BeginScope()

Cancel()

Cancels the current operation or action within the scope.

Declaration

cs-api-definition
public void Cancel()

Implements IScopeFlag.Cancel()

CloseScope()

Closes the current scope, finalizing any operations and releasing resources associated with it.

Declaration

cs-api-definition
protected abstract void CloseScope()

End()

Indicates the end of a scope in the Telerik Windows Controls.

Declaration

cs-api-definition
public void End()

Implements IScopeFlag.End()

OnScopeCanceled()

Invokes the callback for canceling the scope, if it has been set.

Declaration

cs-api-definition
protected virtual void OnScopeCanceled()

OnScopeClosed()

Invokes the callback for closing the scope, if it has been set.

Declaration

cs-api-definition
protected virtual void OnScopeClosed()

OpenScope()

Opens the current scope, allowing for additional operations to be performed within it.

Declaration

cs-api-definition
public abstract void OpenScope()

Implements IScopeFlag.OpenScope()