InsertEncryptedEmailLink Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Encrypts an email adress with the method specified in EncryptionMethod. The generates inline code thus you must wrap it into a block element in order for the resulting code to validate. The code generated is fully HTML/XHTML strict compatible.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingSecurityBase
        ContentStudio.Site.ActiveScripting.SecurityInsertEncryptedEmailLink

Namespace: ContentStudio.Site.ActiveScripting.Security
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public sealed class InsertEncryptedEmailLink : SecurityBase

The InsertEncryptedEmailLink type exposes the following members.

Constructors

  NameDescription
Public methodInsertEncryptedEmailLink
Constructs a new instance of the InsertEncryptedEmailLink class that writes to the default response stream
Public methodInsertEncryptedEmailLink(Stream)
Constructs a new instance of the InsertEncryptedEmailLink class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyClassName
Sets or gets link class The default value is an empty string
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEmailAddress
Sets or gets the email adress The default value is an empty string
Public propertyEmailText
Sets or gets the text of the email link The default value is "Mail me"
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyEncryptionMethod
Sets or gets the EncryptionMethod The default value is EmailEncryptionMethod.ASCII
Public propertyNumBreaks
Sets or gets the number of times the email address will be split. Only used when encrypting using EncryptionMethod.JavascriptASCII
Public propertyTooltip
Sets or gets Tooltip (title attribute) of link The default value is an empty string
Top
Methods

  NameDescription
Public methodAccessCheckForCurrentCategory
Determines if access us granted to the current category for the calling user.
(Inherited from SecurityBase.)
Public methodAccessCheckForCurrentDocument
Determines if access us granted to the current document for the calling user.
(Inherited from SecurityBase.)
Public methodStatic memberEncryptMethod1
Encrypts email address by replacing @ and . to decimal values.
Public methodStatic memberCode exampleEncryptMethod2
Encrypts email address by splitting it into the number of pieces specified in SplitNum. Each piece will have ' surrounding them. The encypted email address returned is intended to be used in a javascript.
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
This method invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Remarks

This class can throw exceptions thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash.
See Also

Reference