ContentStudio.Site.Controls Namespace Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This namespace contains classes that defines Content Studio builtin server controls.

  Class Description
Public class AspectRationTypeConverter
Provides a type converter to convert string representation of Aspect ratios to and from other representations.
Public class BinaryUpload
Binary upload (supports anonymous uploads). This component must be placed in a form element and the caller must have read, create, save and publish permission in the destination category.
Public class CompositeControlBase
Base class for composite controls.
Public class ContentStudioConnectionIdParameter
Binds the value of the current Content Studio connection id variable to a parameter object.
Public class ContentStudioSessionIdParameter
Binds the value of a Content Studio user session variable to a parameter object.
Public class ControlBase
This is the base class for all Content Studio Controls.
Public class CSCategoryAttribute
Defines the attribute that controls use to identify int or string properties containing document id/filename values. This class cannot be inherited.
Public class CustomButton
Custom buttons and functions for Webitor.
Public class CustomButtonCollection
Represents a collection of CustomButton objects
Public class CustomButtonCollectionEditor
Provides a user interface that can edit CustomButtonCollection at design time.
Public class CustomCultureInfoConverter
Cunverter used for property Culture.
Public class CustomImageProcessingSettings
This class contains image processing settings used by BinaryUpload.
Public class DatePickerExtender
The datepicker is tied to a standard form input field. Focus on the input (click, or use the tab key) to open an interactive calendar in a small overlay. Choose a date, click elsewhere on the page (blur the input), or hit the Esc key to close. If a date is chosen, feedback is shown as the input's value.
Public class DatePickerExtenderDateFormatConverter
Get some standard date formats
Public class DatePickerExtenderDurationConverter
Get standard durations.
Public class DatePickerExtenderShowHideToggleEffectsConverter
Toggele effect values.
Public class DateTimeFormat
Handles date time string conversion properties.
Public class DisableCSStandardStyle
This control is used for disabling of the standard stylesheet used in CS. This control will not disable any Themes in use.
Public class DisableCSStandardStyleDisableCSStandardStyleDesigner
Designer for the DisableCSStandardStyle control.
Public class DocumentWriter
Represents a non visual component used to configure Content Studio Editing templates.
Public class DocumentWriterDesigner
Provides design-time support for the DocumentWriter control in a visual designer.
Public class EmailValidator
Validates whether the value of an associated input control matches an email address.
Public class EptButton
Represents a control that displays an Html button that performs actions on an EPT document. Used in Edit templates only.
Public class EptButtonDesigner
Provides design-time support for the EptButton control in a visual designer.
Public class EptDataSource
Allows databound controls to work directly against an ept category.
Public class EptDataSourceView
A data view returned by the EptDataSource that does the actual data execution against the ept category.
Public class EptDateTimeField
Writes a date time value from an EPT field or the current date into the document. There is a number of different swedish standard formats available and an additional possibility to specify a custom format.
Public class EptField
This component is used for showing an ept field in a presentation template.
Public class EptFieldEptFieldDesigner
Designer used for EptField
Public class EptFieldSpecification
This class is used for controls that is bound to EPT-fields in presentation templates.
Public class EptFieldSpecificationConverter
Converter for EptFieldSpecification.
Public class EptHyperLink
This component renders a html hyper link bound to ept fields in a presentation template.
Public class EptHyperLinkDesigner
Designer used for EptHyperLink
Public class EptImage
Displays an image on a Web page.
Public class FacebookJavaScriptSdk
The JavaScript SDK provides a rich set of client-side functionality for accessing Facebook's server-side API calls. These include all of the features of the REST API, Graph API, and Dialogs. Further, it provides a mechanism for rendering of the XFBML versions of our Social Plugins, and a way for Canvas pages to communicate with Facebook.
Public class FacebookLikeButton
The Like button lets a user share your content with friends on Facebook. When the user clicks the Like button on your site, a story appears in the user's friends' News Feed with a link back to your website.When your Web page represents a real-world entity, things like movies, sports teams, celebrities, and restaurants, use the Open Graph protocol to specify information about the entity. If you include Open Graph tags on your Web page, your page becomes equivalent to a Facebook page. This means when a user clicks a Like button on your page, a connection is made between your page and the user. Your page will appear in the "Likes and Interests" section of the user's profile, and you have the ability to publish updates to the user. Your page will show up in same places that Facebook pages show up around the site (e.g. search), and you can target ads to people who like your content.
Public class FacebookOpenGraphAudioTags
You can add an audio file to your markup.
Public class FacebookOpenGraphAudioVideoTags
Public class FacebookOpenGraphAudioVideoTagsEditor
Public class FacebookOpenGraphTags
Open Graph tags are <meta> tags that you add to the <head> of your website to describe the entity your page represents, whether it is a band, restaurant, blog, or something else. An Open Graph tag looks like this:
<meta property="og:tag name" content="tag value"/>
Public class FacebookOpenGraphVideoTags
If you want to attach a video to your Open Graph page you can simply specify a video url. Facebook uses the og:video:type to determine how to render the video in the news feed. In desktop browsers and Flash-enabled mobile browsers, Facebook will render "" as a Flash video. In Safari on the iPad, Facebook will render "" inside an HTML 5 <video> tag. In browsers which support neither Flash nor HTML 5, Facebook will link to "" when the video thumbnail is clicked.
Public class FlashVarParameter
Represents a parameter that can be sent via the FlashVars property of the InsertFlashContent control.
Public class FlashVarParameterCollection
Represents a StateManagedCollection of FlashVarParameter objects. This class is used by the InsertFlashContent control.
Public class FormatPatternConverter
Coverter used for converting format pattern strings
Public class GoogleAnalytics
Google Analytics Tracking Code. Stay in the Loop! Subscribe to our changelog. Asynchronous Tracking Forum. Collect visitor data for your website using the Google Analytics tracking code. The tracking code works by the inclusion of a block of JavaScript code on your website pages. When visitors to your website view a page, this JavaScript code executes the tracking operation for Analytics. Data about the page visit is collected and sent to the Analytics server through a list of parameters attached to a single-pixel image request. Without any customization, the tracking code snippet supplies your Analytics reports with a wide variety of data about your website pages, your visitors' loyalty, AdWords traffic sources, and more. If you want to use Analytics for other types of web analytics—such as ecommerce tracking or tracking visitors across domains—you will need to customize the tracking code.
Public class GoogleAnalyticsCustomVar
Sets a custom variable with the supplied name, value, and scope for the variable. There is a 64-byte character limit for the name and value combined.
Public class GoogleAnalyticsCustomVarsEditor
Public class HighResImageProcessingSettings
This class contains default settings of the original high resolution image, which is saved to the disk. The image is not processed or modified.
Public class ImageDialog
Displays a button that allows users to navigate and upload an image. This control was added in Content Studio version 5.5
Public class ImageDialogDesigner
Provides design-time support for the ImageDialog control in a visual designer.
Public class ImageProcessingSettings
This base class contains image processing settings used by BinaryUpload.
Public class ImageProcessingSettingsCollection
Represents a collection of ImageProcessingSettings objects.
Public class ImageProcessingSettingsCollectionEditor
Provides a user interface that can edit ImageProcessingSettingsCollection at design time.
Public class InsertFieldWithControls
This control is used in a presentation template to display content from the Webitor 2.0 control.
Public class InsertFlashContent
Renders static Html that embeds Adobe Flash content in such a way that will be viewed as active content in web a browser.
Public class InsertFlashContentDesigner
This class is used to supply the InsertFlashContent with design time data. It is only intended for internal use.
Public class InsertScript
Inserts script at current location of the control or at the end of the page head.
Public class InsertScriptDesigner
Design class for InsertScript.
Public class JQuery
jQuery is a fast and concise JavaScript Library that simplifies HTML document traversing, event handling, animating, and Ajax interactions for rapid web development. jQuery is designed to change the way that you write JavaScript. jQuery JavaScript Library v1.3 Copyright (c) 2009 John Resig Dual licensed under the MIT and GPL licenses. Date: 2009-01-13 12:50:31 -0500 (Tue, 13 Jan 2009) Revision: 6104 Sizzle CSS Selector Engine - v0.9.1 Copyright 2009, The Dojo Foundation Released under the MIT, BSD, and GPL Licenses. More information:
Public class JQueryDesigner
Designer used for JQuery
Public class JQueryUI
* jQuery UI 1.7.2 Copyright (c) 2009 AUTHORS.txt ( Dual licensed under the MIT (MIT-LICENSE.txt) and GPL (GPL-LICENSE.txt) licenses. jQuery UI provides abstractions for low-level interaction and animation, advanced effects and high-level, themeable widgets, built on top of the jQuery JavaScript Library, that you can use to build highly interactive web applications.
Public class JQueryUIDesigner
Designer used for JQueryUI
Public class JsonHelper
Public class LinkDialog
Displays a text box and a button that lets the user browse for and select a Content Studio document to link to.
Public class LinkDialogDesigner
Provides design-time support for the LinkDialog control in a visual designer.
Public class LoadUserInfoCookies
Loads a non-persistent cookie collection containing Content Studio data for the current user. This component is typically put on the start page of an application where you need Content Studio data for the logged in user. The following items exist in the cookie collection CS_UserData. Available sub cookies are: FullName, Domain, UserName, Email, SID, UserID, UserKey, LoginDate, PreviousLogin, Trustee
Public class PagedRepeater
A Repeater with basic paging functionality.
Public class PropertyBrowserPage
Public class StringArrayDefaultValueAttribute
Specifies the default value for a property of type string array.
Public class StringInnerPropertyConverter
This class is used by Content Studio infrastructure
Public class SubscribableCategoryCheckBox
Renders a checkbox that represents a subscribable category.
Public class SubscribableCategoryCheckBoxSubscribableCategoryCheckBoxDesigner
This class is used to supply the SubscribableCategoryCheckBox with design time data. It is only intended for internal use.
Public class SubscriptionAction
This control, when placed on a Content Studio document, this control performs actions with one or more subscriber's subscriptions when the page loads and displays the result to the visitor. It requires one or more QueryString named key that contains the subscription key that identifies the subscription to use.
Public class SubscriptionLink
The UnsubscribeLink control renders a link to a document that implements the Content Studio Subscription Services unlink functionality.
Public class SubscriptionManager
Generates a Web control that enables a developer to add functionality for subscribing to one or more Content Studio subscribable categories.
Public class SubscriptionManagerSubscriptionManagerCheckboxItemCollection
Represents a collection of SubscriptionManagerCheckboxItem objects. This class is used internally by the SubscriptionManager control.
Public class SubscriptionManagerSubscriptionManagerDesigner
This class is used to supply the SubscriptionManager with design time data. It is only intended for internal use.
Public class SubscriptionManagerCheckboxItem
Renders a checkbox that represents a subscribable category that is included in a SubscriptionManager control. This class is only used by the SubscriptionManager control.
Public class SubscriptionManagerCompletedEventArgs
This class represents event argument passed to the SubscriptionManager Complete event
Public class SubscriptionManagerImpl
This class implements the ISubscriptionManager interface and provides methods for managing subscriptions.
Public class SubscriptionManagerValidationEventArgs
Defines the event arguments used in the SubscriptionManagerValidate event.
Public class SubscriptionMarker
Insert a marker in a Subscribable document that will be replace by the mail sender by their actual values.
Public class SubscriptionRemover
This clas represents the SubscriptionRemover web control.
Public class SubscriptionRemoverDesigner
This class is used to supply the SubscriptionRemover with design time data. It is only intended for internal use.
Public class ThickBoxLink
ThickBox is a webpage UI dialog widget written in JavaScript on top of the jQuery library. Its function is to show a single image, multiple images, inline content, iframed content, or content served through AJAX in a hybrid modal.
Public class ThumbnailImageProcessingSettings
Generating thumbnails use the same logic as when generating images adjusted for the web. The exception is that the size must be selected. The image will hence be rescaled for the given size. The dpi meta data will be set but it will not be rescaled according to the new dpi settings.
Public class TwitterProfileWidget Obsolete.
Inserts script that embeds a twitter feed from a specific user. This component acts as a wrapper round the Twitter official profile widget.
Public class TwitterProfileWidgetControlDesigner
Provides design-time support for the TwitterProfileWidget control in a visual designer.
Public class TwitterTimeline
Inserts script that embeds a twitter timeline for a specific user. This component acts as a wrapper round the Twitter official embedded time line API and replaces the outdated TwitterProfileWidget component.
Public class TwitterTimelineControlDesigner
Provides design-time support for the TwitterTimelineControlDesigner control in a visual designer.
Public class UniqueMembersStringArrayConverter
Provides a type converter to convert a string of comma-separated values to and from an array of strings. Each member must be unique. Values are case sensitive.
Public class UrlFieldSpecification
This class is used for controls that is bound to url ept-fields in presentation templates.
Public class Utilities
This static class provides general helper methods.
Public class ValidationKey
Class used for validation of parameters in controls
Public class WebControlBase
This is the base class for a Content Studio Web Control.
Public class WebImageProcessingSettings
This class contains default settings of the adjusted copy of the original image. The image is adjusted to be used within web documents by making the image file smaller and with limited display size. If a maximum size is given, the images are scaled to fit within the limits, provided that the original image is larger than the maximum size. If the image format does not support resizing, the meta data is change to reflect 72 dpi resolution. If no maximum size is given, the image resolution is read from its meta data. If the resolution is higher than 72 dpi, it will be scaled (sampled) to 72 dpi. The Method field described which interpolation filter to use for sampling. More information is found in the section Image filters. The Quality level is only used for compression if the image format allows it. Currently, compression is only used for JPEG images. Low quality numbers indicate high compression with low picture quality and small file size. By adding image sharpening, blurred pictures may seem sharper by exposing pixels that are distinctively different from its surrounding. With smart resizing, the picture orientation is investigated. If the image uses portrait orientation, the given values for maximum with and height will change place.
Public class Webitor
This gerates at WYSIWYG editor for HTML. This component works only with IE 6 and later. If another browser is used, an ordinary textarea will be displayed.
Public class WebitorThemeConverter
Shows all available themes in a drop down.
Public class WebitorToolbar
Represents a separate configurable toolbar for the Content Studio Webitor control
Public class WebitorToolbarControlDesigner
Provides design-time support for the WebitorToolbar control in a visual designer.
Public class WebTrace
Common techniques for outputting web trace.
Public class WebUIServiceHost
This class is only intended for Content Studio infra structure.
Public class WebUIServiceHostMessage
Represents a message
Public class WebUIServiceHostMessageResult
Represents a message result
Public class WebUIServiceHostWebUIControl
This class is only intended for Content Studio infra structure.
Public class WebUIServiceHostWebUIState
This class is only intended for Content Studio infra structure.
Public class VirtualPathProviderDataSource
Supports the VirualPathDataSourceView control and provides an interface for data-bound controls to perform virtual path operations against a virtual file system.
Public class VirualPathDataSourceView
Represents an virtual path to data-bound controls.

  Interface Description
Public interface ISubscriptionManager
Defines the members that an application that manages a subscribers subscription must implement.
Public interface IWebUITypeControl
This interface chould be implemented for controls that handels property values on a custom WebControlUITypeEditor

  Enumeration Description
Public enumeration DatePickerExtenderShowOnValues
Have the datepicker appear automatically when the field receives focus ('focus'), appear only when a button is clicked ('button'), or appear when either event takes place ('both').
Public enumeration DocumentWriterOperationModeValue
Determines how DocumentWriter interact with the user while performing an operation.
Public enumeration DocumentWriterSaveStateValue
Determines how DocumentWriter performs save / approve / versioning operations.
Public enumeration EptButtonEptButtonAction
Defines the actions that can be peformed by the EptButton
Public enumeration EptDataSourceContentToLoad
Specifies what version of a document to use
Public enumeration EptDataSourcePermissionToCheck
Specifies what type of permission that Content Studio should check for during the filter operation.
Public enumeration EptFieldRenderMode
Represents the possible layout rendering options for the content of an EptField control on a page.
Public enumeration FacebookAction
The verb to display on the button. Options: 'like', 'recommend'
Public enumeration FacebookColorScheme
The color scheme for the like button. Options: 'light', 'dark'
Public enumeration FacebookFont
The font to display in the button. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
Public enumeration FacebookLayoutStyle
FacebookLayoutStyle, there are three options.
Public enumeration FacebookRenderMode
There are two Like button implementations: XFBML and Iframe. The XFBML (also available in HTML5-compliant markup) version is more versatile, but requires use of the JavaScript SDK. The XFBML dynamically re-sizes its height according to whether there are profile pictures to display, gives you the ability (through the Javascript library) to listen for like events so that you know in real time when a user clicks the Like button, and it always gives the user the ability to add an optional comment to the like. If users do add a comment, the story published back to Facebook is given more prominence.
Public enumeration GoogleAnalyticsCustomVarScope
The scope used for the custom variable. Possible values are 1 for visitor-level, 2 for session-level, and 3 for page-level.
Public enumeration InsertFlashContentAlignment
Defines how the player aligns its movie content.
Public enumeration InsertFlashContentPlaybackQuality
Defines the quality of the flash movie playback in the InsertFlashContent control.
Public enumeration InsertFlashContentScaledAlignment
ScaledAlignment of the Flash Movie.
Public enumeration InsertFlashContentScaling
Defines how the content in the InsertFlashContent control can be scaled
Public enumeration InsertFlashContentScriptAccess
The AllowScriptAccess parameter in the HTML code that loads a SWF file controls the ability to perform outbound URL access from within the SWF file.
Public enumeration InsertFlashContentWindowMode
Determines Window Mode property of the Flash movie for transparency, layering, and positioning in the browser.
Public enumeration JQueryJQueryVersion
Tells which version of JQuery to use
Public enumeration JQueryUIJQueryShowHideToggleEffects
Effects that can be used with Show/Hide/Toggle:
Public enumeration JQueryUIJQueryUICSSTheme
Specifies wich built in css theme to use with JQueryUI.
Public enumeration JQueryUIJQueryUIVersion
Tells which version of JQueryUI to use
Public enumeration SubscriptionActionActionValue
Defines the actions that this control can perform.
Public enumeration SubscriptionMarkerMarkerValue
Defines the marker values that will be replaced by the mail sender by the actual values
Public enumeration ThickBoxLinkContentModes
Tells how thickbox will display content.
Public enumeration TwitterProfileWidgetBehaviorType
Controls the display behavior of the TwitterProfileWidget component.
Public enumeration TwitterTimelineTwitterTimelineAriaPoliteness
Defines the supported ARIA accessibility settings used by the TwitterTimeline component.
Public enumeration TwitterTimelineTwitterTimelineTheme
Represents the different themes that can be applied to this TwitterTimeline
Public enumeration WebitorDocumentCompatibilityMode
Internet Explorer 8 and later supports a number of document compatibility modes that enable different features and can affect the way content is displayed.
Public enumeration WebitorDocumentType
Document type output
Public enumeration WebitorLiveObjectEditingLevel
Live object editing level.
Public enumeration WebitorWebitorFeatures
Buttons and functionality to display in Webitor control.
Public enumeration WebitorWebitorLanguage
Webitor language
Public enumeration WebitorToolbarButtonsEnabledFeatures
Specifies a combination of buttons to show in the WebitorToolbar control.