Content Studio Web Content Management System

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

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScripting.MiscTellAFriend

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

The TellAFriend type exposes the following members.

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

Top

	Name	Description
	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.)
	FriendsEmail	Sets or gets the label of the field with the address of your friend. The default value is "Your friends email".
	InvalidEmail	Sets or gets the message that will be displayed if the FROM address is incorrect. If this is an empty string, no email validation performed. The default value is "Invalid email".
	InvalidToEmail	Sets or gets the message that will be displayed if the TO address is incorrect. If this is an empty string, no email validation performed. The default value is an empty string
	MailSent	Gets a value indicating the a mail has been sent
	MessageBoxLabel	Sets or gets the label of the field with the text message. The default value is "Comment".
	NoName	Sets or gets the message that will be displayed if the FROM name is not specified. The default value is an empty string.
	Password	Sets or gets the password for the mail server. The default value is an empty string
	SendText	Sets or gets the caption of the send button. The default value is "Send".
	ServerName	Sets or gets the name or IP address of the mail server. The default value is an empty string.
	ShowMessageBox	Sets or gets a value indicating if the user can supply a message in the mail. The default value is an false.
	strBodyBegin	Sets or gets the first part of the mail body. The default value is " has sent you a link. <br />Click the link below to reach the page.<br /><br />".
	strBodyEnd	Sets or gets the last part of the mail body. The default value is an empty string.
	strHeadline	Sets or gets the headline of the mail body. The default value is "Hello<br /><br />".
	strSubject	Sets or gets the mail subject line. The default value is "Read this article".
	ThanksText	Sets or gets the message that will be displayed when the mail is sent. The default value is an "Thank you.".
	Username	Sets or gets the username to be used with the mail server. The default value is an empty string
	YourEmail	Sets or gets the label of the field with the your email address. The default value is "Your email".
	YourName	Sets or gets the label of the field with the your name. The default value is "Your name". The senders name will be displayed in the mail body.

Top

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Invoke	Invokes the component and writes its content into the specified stream
	ToString	(Inherited from Object.)

Top To use this class, create an instance of this object, and call the Invoke method with an appropriate set of parameters and properties. 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