Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingSecurityBase
        ContentStudio.Site.ActiveScripting.SecurityPermissionDependentComponent
          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)

The InsertLinkIfWritePermission type exposes the following members.

	Name	Description
	InsertLinkIfWritePermission	Constructs a new instance of the InsertLinkIfWritePermission class that writes to the default response stream
	InsertLinkIfWritePermission(Stream)	Constructs a new instance of the InsertLinkIfWritePermission class that writes to the supplied stream

Top

	Name	Description
	AccessMask	Sets or gets the permission or combination of permissions to check for. The default value is CSObjectPermissions.Read. (Inherited from PermissionDependentComponent.)
	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.)
	ClassName	Sets or gets a value that contains the CSS class name that should be applied to the generated link or button. The default value is an empty string
	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.)
	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.)
	EditRoot	Sets or gets a value that indicates if the permission of root document should be used when opening a document for editing. Default value is false. (use the permissions of the inserted document)
	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.)
	LinkText	Gets or sets the text to display in the link. The default value is an empty string
	LinkType	Sets or gets the link type to generate. The default value is InsertLinkByPermission.LinkTypes.Link.
	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. (Inherited from PermissionDependentComponent.)
	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. (Inherited from PermissionDependentComponent.)
	Page	A reference to the current context page. This will initialize in the constructor of this class. (Inherited from CodeBase.)
	RedirectDocument	Sets or gets a value that indicates a document to redirect to, if permission for the caller was found. The default value is zero, which will not redirect the caller.
	RedirectDocumentPresentationTemplate	Sets or gets the presentation template to use with the document specified in RedirectDocument. The default value is zero (no presentation template is used).
	RunningUserControl	Gets the current running user control. (Inherited from CodeBase.)
	Target	Sets or gets a value that specifies the TARGET attribute of the generated link. The default value is an empty string

Top

	Name	Description
	AccessCheck	Performs an access check when the Invoke method is called, based on the value of the ObjectToCheck, AccessMask and ObjectType properties. (Inherited from PermissionDependentComponent.)
	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, causing an access check to be performed before raising the OnRender event. (Overrides PermissionDependentComponentInvoke.)
	Invoke(PermissionDependentComponent)	Invokes the component by performing the checks and reporting the result to the OnRender event handler of the derived class. (Inherited from PermissionDependentComponent.)
	MemberwiseClone	(Inherited from Object.)
	OnRender	Target for the OnRender event, that renders the content to the specified output stream. (Overrides PermissionDependentComponentOnRender(Object, RenderEventArgs).)
	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.)

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 class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code is fully HTML/XHTML strict compatible.

Reference