Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingSecurityBase
ContentStudio.Site.ActiveScripting.SecurityPermissionDependentComponent
ContentStudio.Site.ActiveScripting.SecurityInsertLinkByPermission
ContentStudio.Site.ActiveScripting.SecurityInsertLinkIfWritePermission
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
When deriving from this class you must implement the OnRender
event handler and the public Invoke method.
In your implementation of the Invoke method you can set
properties in the base class and finally you call the protected
overloaded version of the Invoke passing a reference to the
class instance (this).
The actual work is done in the OnRender event that will
automatically be raised by the base class after that the access check
has been made. It is also possible to provide your own access check
mechanism by overriding the AccessCheck method.
[This is preliminary documentation and is subject to change.]
This abstract class acts as a base class for all classes that
renders its content depending on the caller's access rights to an
object.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingSecurityBase
ContentStudio.Site.ActiveScripting.SecurityPermissionDependentComponent
ContentStudio.Site.ActiveScripting.SecurityInsertLinkByPermission
ContentStudio.Site.ActiveScripting.SecurityInsertLinkIfWritePermission
Namespace: ContentStudio.Site.ActiveScripting.Security
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The PermissionDependentComponent type exposes the following members.
Constructors
Name | Description | |
---|---|---|
PermissionDependentComponent | Initializes a new instance of the PermissionDependentComponent class |
Properties
Name | Description | |
---|---|---|
AccessMask |
Sets or gets the permission or combination of permissions to check for.
The default value is CSObjectPermissions.Read.
| |
BackwardsComponentCompatibilityMode |
Sets or gets a value that indicates whether the code runs in backwards
compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.) | |
ComponentName |
Gets the name of the component
(Inherited from ActiveScriptingBase.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Inherited from ActiveScriptingBase.) | |
CS_DataFields |
Gets a EPTXmlParser that contains a collection of EPT field definitions and values.
This property is the replacement for the obsolete EPT_GetFieldName(String) and EPT_GetFieldValue(String) methods.
(Inherited from CodeBase.) | |
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Inherited from ActiveScriptingBase.) | |
Encoding |
Sets or gets the encoding the component uses. The default encoding is
the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.) | |
ObjectToCheck |
Sets or gets a value that indicates the id of the Content Studio object to perform the access check on.
The default value is 1.
| |
ObjectType |
Sets or gets a value that indicates what type of object that is
referenced in the ObjectToCheck property. The caller's
permission will be checked against this object when the derived class
calls the Invoke method. The default value is CSSecurableObjects.DocumentItem.
| |
Page |
A reference to the current context page.
This will initialize in the constructor of this class.
(Inherited from CodeBase.) | |
RunningUserControl |
Gets the current running user control.
(Inherited from CodeBase.) |
Methods
Name | Description | |
---|---|---|
AccessCheck |
Performs an access check when the Invoke method is called, based
on the value of the ObjectToCheck, AccessMask and ObjectType
properties.
| |
AccessCheckForCurrentCategory |
Determines if access us granted to the current category for
the calling user.
(Inherited from SecurityBase.) | |
AccessCheckForCurrentDocument |
Determines if access us granted to the current document for
the calling user.
(Inherited from SecurityBase.) | |
BuildHTMLComponentException |
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GenerateLinkTargetAttribute |
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.) | |
GetCorrectField |
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component. Derived classes call the overloaded Invoke
method from this method, passing a reference to the PermissionDependentComponent
derived class that should receive the OnRender event.
| |
Invoke(PermissionDependentComponent) |
Invokes the component by performing the checks and reporting the result
to the OnRender event handler of the derived class.
| |
MemberwiseClone | (Inherited from Object.) | |
OnRender |
Target for the OnRender event, that renders the content to the
specified output stream.
| |
ReadFromApplicationCache |
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.) | |
SetApplicationCache |
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.) | |
SyncronizeMLC |
Provides support for components that needs to be MLC aware, by
localizing the supplied category or presentation template from the
current document, or the preferred language of the visitor.
(Inherited from ActiveScriptingBase.) | |
ToString | (Inherited from Object.) | |
WriteAttribute(TextWriter, String, String) |
Writes an attribute string to the supplied stream, unless Value is
an empty string or null (Inherited from ActiveScriptingBase.) | |
WriteAttribute(TextWriter, String, String, Boolean) |
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.) |
Remarks
See Also