SubscriptionRemover Class

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

This clas represents the SubscriptionRemover web control.

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsCompositeControl
        ContentStudio.Site.ControlsCompositeControlBase
          ContentStudio.Site.ControlsSubscriptionRemover

Namespace: ContentStudio.Site.Controls
Assembly: ContentStudio.Site.Controls (in ContentStudio.Site.Controls.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public class SubscriptionRemover : CompositeControlBase

Public Class SubscriptionRemover
	Inherits CompositeControlBase

The SubscriptionRemover type exposes the following members.

Constructors

	Name	Description
	SubscriptionRemover	Initializes a new instance of the SubscriptionRemover class.

Top

Properties

	Name	Description
	AccessKey	(Inherited from WebControl.)
	Adapter	(Inherited from Control.)
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	Attributes	(Inherited from WebControl.)
	BackColor	(Inherited from WebControl.)
	BindingContainer	(Inherited from Control.)
	BorderColor	(Inherited from WebControl.)
	BorderStyle	(Inherited from WebControl.)
	BorderWidth	(Inherited from WebControl.)
	ButtonText	Gets or sets the button text in the control.
	ChildControlsCreated	(Inherited from Control.)
	ClientID	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	CommentCssClass	Gets or sets the Css class to apply to the the comment text displayed under the headline..
	CommentText	Gets or sets the comment text displayed under the headline..
	ConfirmationMailSenderAddress	Gets or sets the confirmation mail sender address. This property is used only when activation via email is needed.
	ConfirmationMessageDocument	Gets or sets the the confirmation mail document.
	Context	(Inherited from Control.)
	Controls	(Inherited from CompositeControl.)
	ControlStyle	(Inherited from WebControl.)
	ControlStyleCreated	(Inherited from WebControl.)
	CssClass	(Inherited from WebControl.)
	DesignMode	(Inherited from Control.)
	Enabled	(Inherited from WebControl.)
	EnableTheming	(Inherited from WebControl.)
	EnableViewState	(Inherited from Control.)
	Events	(Inherited from Control.)
	Font	(Inherited from WebControl.)
	ForeColor	(Inherited from WebControl.)
	HasAttributes	(Inherited from WebControl.)
	HasChildViewState	(Inherited from Control.)
	Height	(Inherited from WebControl.)
	ID	(Inherited from Control.)
	Identifier	Gets or sets the identifier of the subscriber. This value is normally the subscriber's email address.
	IdSeparator	(Inherited from Control.)
	IncludeDisabled	Gets or sets a value indicating whether to include disabled subscriptions where the subscriber has a subscription..
	IsChildControlStateCleared	(Inherited from Control.)
	IsEnabled	(Inherited from WebControl.)
	IsTrackingViewState	(Inherited from Control.)
	IsViewStateEnabled	(Inherited from Control.)
	LoadViewStateByID	(Inherited from Control.)
	NamingContainer	(Inherited from Control.)
	NoSubscriptionText	Gets or sets the text shown as headline when there are no subscriptions for the user.
	NothingSelectedText	Gets or sets the text shown when the user subsmits data without having any items selected.
	Page	Gets a reference to the Page instance that contains the server control. (Inherited from CompositeControlBase.)
	Parent	(Inherited from Control.)
	RequiresConfirmation	Gets or sets a value indicating whether the user must confirm the removal of the selected subscriptions..
	Site	(Inherited from Control.)
	SkinID	(Inherited from WebControl.)
	Style	(Inherited from WebControl.)
	SubscriptionImplementation	Gets or sets the string representation of the type information to a class that implements the ISubscriptionManager interface that handles the subscription.
	SuccessText	Gets or sets the text shown when a subscriber has successfully performed the removal operation. This text will never be used if a SuccessUrl has been specified.
	SuccessUrl	Gets or sets a Url to a document that the control forces the page to move to after a successful subscription.
	TabIndex	(Inherited from WebControl.)
	TagKey	Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Overrides WebControlTagKey.)
	TagName	(Inherited from WebControl.)
	TemplateControl	(Inherited from Control.)
	TemplateSourceDirectory	(Inherited from Control.)
	Text	Gets or sets the header text of the control.
	ToolTip	(Inherited from WebControl.)
	UniqueID	(Inherited from Control.)
	ValidationCssClass	Gets or sets the Css class to apply to the the validation text displayed when the user forgot to select a subscription..
	Width	(Inherited from WebControl.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)
	Visible	(Inherited from Control.)

Top

Methods

	Name	Description
	AddAttributesToRender	(Inherited from WebControl.)
	AddedControl	(Inherited from Control.)
	AddParsedSubObject	(Inherited from Control.)
	ApplyStyle	(Inherited from WebControl.)
	ApplyStyleSheetSkin	(Inherited from Control.)
	BuildProfileTree	(Inherited from Control.)
	ClearChildControlState	(Inherited from Control.)
	ClearChildState	(Inherited from Control.)
	ClearChildViewState	(Inherited from Control.)
	CopyBaseAttributes	(Inherited from WebControl.)
	CreateChildControls	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Overrides ControlCreateChildControls.)
	CreateControlCollection	(Inherited from Control.)
	CreateControlStyle	(Inherited from WebControl.)
	DataBind	(Inherited from CompositeControl.)
	DataBind(Boolean)	(Inherited from Control.)
	DataBindChildren	(Inherited from Control.)
	Dispose	(Inherited from Control.)
	EnsureChildControls	(Inherited from Control.)
	EnsureID	(Inherited from Control.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FindControl(String)	(Inherited from Control.)
	FindControl(String, Int32)	(Inherited from Control.)
	Focus	(Inherited from Control.)
	GetDesignModeState	(Inherited from Control.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	LoadControlState	(Inherited from Control.)
	LoadViewState	(Inherited from WebControl.)
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	MergeStyle	(Inherited from WebControl.)
	OnBubbleEvent	(Inherited from Control.)
	OnComplete	Raises the Complete event.
	OnDataBinding	(Inherited from Control.)
	OnInit	(Inherited from Control.)
	OnLoad	Raises the Load event. (Overrides ControlOnLoad(EventArgs).)
	OnPreRender	(Inherited from Control.)
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	RaiseBubbleEvent	(Inherited from Control.)
	RecreateChildControls	(Inherited from CompositeControl.)
	RemovedControl	(Inherited from Control.)
	Render	Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client. (Overrides CompositeControlRender(HtmlTextWriter).)
	RenderBeginTag	(Inherited from WebControl.)
	RenderChildren	(Inherited from Control.)
	RenderContents	(Inherited from WebControl.)
	RenderControl(HtmlTextWriter)	(Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	(Inherited from Control.)
	RenderEndTag	(Inherited from WebControl.)
	ResolveAdapter	(Inherited from Control.)
	ResolveClientUrl	(Inherited from Control.)
	ResolveUrl	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	(Inherited from WebControl.)
	SetDesignModeState	(Inherited from Control.)
	SetRenderMethodDelegate	(Inherited from Control.)
	ToString	(Inherited from Object.)
	TrackViewState	(Inherited from WebControl.)
	UpdateDesignerPropertyChanged	Signals the designer to update the graphical representation of this control. (Inherited from CompositeControlBase.)

Top

Events

	Name	Description
	Complete	Occurs when the SubscriptionRemover has completed its job.
	DataBinding	(Inherited from Control.)
	Disposed	(Inherited from Control.)
	Init	(Inherited from Control.)
	Load	(Inherited from Control.)
	PreRender	(Inherited from Control.)
	Unload	(Inherited from Control.)

Top

Remarks

When used on a Content Studio document it provides a vistior with a list of new newsletter subscriptions and offers the possibility to remove them (unsubscribe). The document author must provide a way of collection the visitior's email address that must be set before this control works.

Reference

ContentStudio.Site.Controls Namespace