pluginbase.Helpers.Attributes.ScopeAttribute Class Reference

Class that represents an abstract definition of a scope More...

Inheritance diagram for pluginbase.Helpers.Attributes.ScopeAttribute:

Public Types
enum	Special { Special.Wildcard }

Public Member Functions
	ScopeAttribute ()
	ScopeAttribute (object scopeEnum)
bool	HasScope (Enum scope)
override string	ToString ()

Properties
Enum	Scope [get, set]
bool	IsFlags [get]
bool	ScopeDefined [get]

Detailed Description

Class that represents an abstract definition of a scope

Attribute: AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = true)

Member Enumeration Documentation

Special

enum pluginbase.Helpers.Attributes.ScopeAttribute.Special

strong

Enumerator
Wildcard

        {
            Wildcard
        }

Constructor & Destructor Documentation

ScopeAttribute() [1/2]

pluginbase.Helpers.Attributes.ScopeAttribute.ScopeAttribute

(

)

        { }

ScopeAttribute() [2/2]

pluginbase.Helpers.Attributes.ScopeAttribute.ScopeAttribute

(

object

scopeEnum

)

        {
            this.Scope = scopeEnum as Enum;
        }

Member Function Documentation

HasScope()

bool pluginbase.Helpers.Attributes.ScopeAttribute.HasScope

(

Enum

scope

)

        {
            //If any scope is acceptable, hurray
            if (scope != null && scope.Equals(Special.Wildcard))
                return true;

            if (_scope == null)
                return scope == null; //If we're null, and we're checking for null then TRUE
            if (scope == null)
                return false; //If we're not null, and checking for null, FALSE

            //If we're equal wildcard, apply to non-null checks (If we're checking for NULL scope, we don't apply)
            if (_scope.Equals(Special.Wildcard))
                return true;

            if (this.IsFlags)
                return _scope.HasFlag(scope); //Else, HasFlag

            return _scope.Equals(scope);
        }

ToString()

override string pluginbase.Helpers.Attributes.ScopeAttribute.ToString

(

)

        {
            return _scope == null ? "Null" : _scope.ToString();
        }

Property Documentation

IsFlags

bool pluginbase.Helpers.Attributes.ScopeAttribute.IsFlags

get

Scope

Enum pluginbase.Helpers.Attributes.ScopeAttribute.Scope

getset

ScopeDefined

bool pluginbase.Helpers.Attributes.ScopeAttribute.ScopeDefined

get

---

The documentation for this class was generated from the following file:

• pluginbase/Helpers/Attributes/ScopeAttribute.cs