System.Security.Permissions.PermissionSetAttribute Class

Summary

Allows security actions for a PermissionSet to be applied to code using declarative security. This class cannot be inherited.

C# Syntax:

[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Constructor | AttributeTargets.Method)] [Serializable] public sealed class PermissionSetAttribute : CodeAccessSecurityAttribute

The PermissionSetAttribute properties PermissionSetAttribute.Name, PermissionSetAttribute.File, and PermissionSetAttribute.XML are mutually exclusive, meaning that a permission set can have as its source only one of the following: a named permission set, a file containing an XML representation of a permission set, or a string containing an XML representation of a permission set.

The scope of the declaration that is allowed depends on the SecurityAction that is used. A SecurityAction performed on a PermissionSet is the equivalent of performing that action on each of the permissions within the set.

The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the corresponding permission class.

System.Security.Permissions Namespace See also:
MSDN: extendingmetadatausingattributes | PermissionSet | NamedPermissionSet

System.Security.Permissions.PermissionSetAttribute Member List:

Public Constructors

ctor #1

Initializes a new instance of the PermissionSetAttribute class with the specified SecurityAction.

Public Properties

Action (inherited from System.Security.Permissions.SecurityAttribute)	Read-write See base class member description: System.Security.Permissions.SecurityAttribute.Action Gets or sets a security action.
File	Read-write Gets or sets a file containing the XML representation of a custom permission set to be declared.
Name	Read-write Gets or sets the name of the permission set.
TypeId (inherited from System.Attribute)	Read-only See base class member description: System.Attribute.TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
UnicodeEncoded	Read-write Gets or sets a value indicating whether the file specified by PermissionSetAttribute.File is Unicode or ASCII encoded.
Unrestricted (inherited from System.Security.Permissions.SecurityAttribute)	Read-write See base class member description: System.Security.Permissions.SecurityAttribute.Unrestricted Gets or sets a value indicating whether full (unrestricted) permission to the resource protected by the attribute is declared.
XML	Read-write Gets or sets the XML representation of a permission set.

Public Methods

CreatePermission	Overridden: Creates and returns a new IPermission.
CreatePermissionSet	Creates and returns a new PermissionSet.
Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Attribute)	See base class member description: System.Attribute.GetHashCode Returns the hash code for this instance.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
IsDefaultAttribute (inherited from System.Attribute)	See base class member description: System.Attribute.IsDefaultAttribute When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
Match (inherited from System.Attribute)	See base class member description: System.Attribute.Match When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Attribute
• System.Security.Permissions.SecurityAttribute
• System.Security.Permissions.CodeAccessSecurityAttribute
• System.Security.Permissions.PermissionSetAttribute

System.Security.Permissions.PermissionSetAttribute Member Details

Summary

Initializes a new instance of the PermissionSetAttribute class with the specified SecurityAction.

C# Syntax:

public PermissionSetAttribute(    SecurityAction action );

action

One of the SecurityAction values.

Return to top

Inherited
See base class member description: System.Security.Permissions.SecurityAttribute.Action

Summary

Gets or sets a security action.

C# Syntax:

public SecurityAction Action {get; set;}

This property is inherited by all classes implementing custom attributes for declarative security.

Return to top

Summary

Gets or sets a file containing the XML representation of a custom permission set to be declared.

C# Syntax:

public string File {get; set;}

If the file specified is Unicode, set the PermissionSetAttribute.UnicodeEncoded property to true.

Return to top

Summary

Gets or sets the name of the permission set.

C# Syntax:

public string Name {get; set;}

Because named permission sets can vary from computer to computer, the use of named permission sets for declarative security is restricted to the immutable named permission sets included as part of the default policy. This ensures that the permissions contained in the permission set referenced will be the same wherever the code is run. A compiler error will be thrown if a mutable or unrecognized named permission set is used.

Return to top

Inherited
See base class member description: System.Attribute.TypeId

Summary

When implemented in a derived class, gets a unique identifier for this Attribute.

C# Syntax:

public virtual object TypeId {get;}

As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

Return to top

Summary

Gets or sets a value indicating whether the file specified by PermissionSetAttribute.File is Unicode or ASCII encoded.

C# Syntax:

public bool UnicodeEncoded {get; set;}

If this property is not set, the file is assumed to be ASCII.

If PermissionSetAttribute.File is null this property is not used.

Return to top

Inherited
See base class member description: System.Security.Permissions.SecurityAttribute.Unrestricted

Summary

Gets or sets a value indicating whether full (unrestricted) permission to the resource protected by the attribute is declared.

C# Syntax:

public bool Unrestricted {get; set;}

This property is inherited by all classes implementing custom attributes for declarative security.

Return to top

Summary

Gets or sets the XML representation of a permission set.

C# Syntax:

public string XML {get; set;}

Return to top

Summary

Creates and returns a new IPermission.

C# Syntax:

public override IPermission CreatePermission();

Return Value:

A new IPermission.

This method is not used, and is included only to support inheritance from SecurityAttribute.

Return to top

Summary

Creates and returns a new PermissionSet.

C# Syntax:

public PermissionSet CreatePermissionSet();

Return Value:

A new PermissionSet.

This method should only be called by the security system, never by application code.

Attributes are used at compile time to convert security declarations to a serialized form in metadata. Declarative security data in metadata is created from the permission object this method returns corresponding to this attribute instance.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~PermissionSetAttribute();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.GetHashCode

Summary

Returns the hash code for this instance.

C# Syntax:

public override int GetHashCode();

Return Value:

A 32-bit signed integer hash code.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.IsDefaultAttribute

Summary

When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.

C# Syntax:

public virtual bool IsDefaultAttribute();

Return Value:

true if this instance is the default attribute for the class; otherwise, false.

The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard, default value obtained by some means, then returns a Boolean value that indicates whether the value of this instance is equal to the standard. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

Return to top

Inherited
See base class member description: System.Attribute.Match

Summary

When overridden in a derived class, returns a value indicating whether this instance equals a specified object.

C# Syntax:

public virtual bool Match(    object obj );

obj

An Object to compare with this instance of Attribute.

Return Value:

true if this instance equals obj; otherwise, false.

This method determines if one Attribute equals another. Its default implementation is the same as Attribute.Equals, which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. For example, consider an attribute whose value is a binary field divided into a bitfield of flags. Two instances of this attribute have one flag in set in common while all the other flags differ. The Equal method cannot determine that the two instances have the same flag set, but the Match method can.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page