Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingSecurityBase
ContentStudio.Site.ActiveScripting.SecurityGroupIncludeOrRedirect
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
To use this class, create an instance of this object, set up the
properties, and call the Invoke method with an appropriate set
of parameters.
This class can throw exceptions, thus your code should be wrapped
within try/catch statements in order to avoid the entire page to crash.
[This is preliminary documentation and is subject to change.]
Redirects the caller to a document, or includes a document based on the
caller's membership in one or more groups. The code is written to the
supplied stream or to the default response stream.
The GroupIncludeOrRedirect class acts as the underlying engine
for the Group include or redirect AS component.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingSecurityBase
ContentStudio.Site.ActiveScripting.SecurityGroupIncludeOrRedirect
Namespace: ContentStudio.Site.ActiveScripting.Security
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The GroupIncludeOrRedirect type exposes the following members.
Constructors
Name | Description | |
---|---|---|
GroupIncludeOrRedirect |
Constructs a new instance of the GroupIncludeOrRedirect class
that writes to the default response stream
| |
GroupIncludeOrRedirect(Stream) |
Constructs a new instance of the GroupIncludeOrRedirect class
that writes to the supplied stream
|
Properties
Name | Description | |
---|---|---|
Action |
Sets or gets a value that indicates what to do when the caller is a
member of the group specified in the Group property or the
caller's group memberships matches the Groupfilter. The default
value is Action.Include.
| |
AlternateAction |
Sets or gets a value that indicates what to do when the caller not
is a member of the group specified in the Group property or the
caller's group memberships does not match the Groupfilter. The
default value is Actions.Include | |
AlternateTargetDocumentId |
Sets or gets the ID of the document that should either be included or
redirected to if the caller not is a member of the group
specified in the Group property or the caller's group
memberships does not match the Groupfilter. The default value is
zero
| |
AlternateTargetPresentationTemplate |
Sets or gets the ID of the presentation template that should be used
when presenting the AlternateTargetDocumentId. The default value
is zero
| |
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 (Overrides ActiveScriptingBaseComponentName.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.) | |
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.) | |
Encoding |
Sets or gets the encoding the component uses. The default encoding is
the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.) | |
Group |
Sets or gets a group name that the user should be a member of. The
default value is an empty string
| |
Groupfilter |
Sets or gets a value that specifies a filter criteria for the groups
that the caller should be a member of. The default value is an empty
string.
| |
GroupfilterEvaluationRule |
Sets or gets a value that indicates how the groups in the Groupfilter
must match the caller's memberships in order to evaluate to true.
The default value is GroupfilterEvaluationRules.Any.
| |
TargetDocumentId |
Sets or gets the ID of the document that should either be included or
redirected to if the caller is a member of the group specified
in the Group property or the caller's group memberships does not
match the Groupfilter. The default value is zero
| |
TargetPresentationTemplate |
Sets or gets the ID of the presentation template that should be used
when presenting the TargetDocumentId. The default value is zero
|
Methods
Name | Description | |
---|---|---|
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.) | |
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component and writes its content into the specified stream.
| |
RestoreGroupNameFormat |
Returns the inverse format of the group names or the group filter,
from the regular DOMAINNAME format used by the Groupfilter
property.
| |
ToString | (Inherited from Object.) |
Remarks
See Also