CMS.UIControls Namespace

Kentico 8.1 API Reference

Classes

	Class	Description
	AbstractAttribute	Abstract attribute class.
	AbstractCMSPage	Base page for all the CMS pages.
	AbstractElementAttribute	Abstract class for the element attributes.
	AbstractMasterPage	Base class for CMS master pages.
	AbstractSecurityAttribute	Abstract class for the security attributes.
	AccessDeniedPage	Base page used for 'Access Denied' pages.
	ActionAttribute	Adds action to the page.
	AllLog	Merging log control for debug purposes.
	AnalyticsLog	Cache log base class.
	AnchorDropup	Base class for anchor dropup.
	ApplicationHelper	Provides functionality for working with applications.
	AsyncWorker	Worker class for asynchronous operations.
	AttributesHelper	Class attributes helper.
	BannerCategorySelector	Form control for the banner category selection.
	BannerTypeSelector	Form control for the banner type selection.
	BaseFieldEditor	Base control for field editor and form builder.
	BaseSchedulingControl	Base class for time scheduling controls
	BreadcrumbAttribute	Adds breadcrumb to the page.
	BreadcrumbItem	Class representing breadcrumbs item.
	Breadcrumbs	BreadCrumbs control base class.
	BreadcrumbsAttribute	Tabs definition.
	CacheLog	Cache log base class.
	CaptchaImage	Summary description for CaptchaImage.
	CaptchaSelector	Form control for captcha type selection.
	CategoryListPanel	Class for listing categories.
	CategoryPanel	Panel-groups for properties.
	CategoryPanelRow	Class for Property Panel Rows.
	CloneSettingsControl	Base class for clone settings controls.
	CMSAbstractEditablePage	Base page for editable items
	CMSAbstractNewDocumentControl	NewDocumentControl abstract class
	CMSAbstractUIWebpart	Abstract class for web parts used in UI
	CMSABTestPage	Base class for UI pages of AB test.
	CMSAbuseReportPage	Base page for the CMS Abuse report pages to apply global settings to the pages.
	CMSAdminControl	Administration interface control - Base control used for the standard administration interface.
	CMSAdminEditControl	Administration edit control
	CMSAdministrationPage	Base page for the Administration section to apply global settings to the pages.
	CMSAdminItemsControl	Summary description for CMSAdminItemsControl.
	CMSAdminListControl	Summary description for CMSAdminListControl.
	CMSAnalyticsContentPage	Base page for the analytics pages.
	CMSAPIExampleException	API example exception might be thrown when something expectedly fails during executing an API example.
	CMSAPIExamplePage	Base page for the Controls examples pages to apply global settings to the pages.
	CMSBannedIPsPage	Base page for the banned IPs tab of administration pages to apply global settings to the pages.
	CMSBannerManagementEditPage	Provides functionality specific to BannerManagement pages in Tools where Banner Category is edited, so permission for specific site.
	CMSBannerManagementPage	Provides functionality specific to BannerManagement pages in Tools.
	CMSBizFormPage	Base page for the CMS BizForms pages to apply global settings to the pages.
	CMSBlogsPage	Base page for the CMS Blogs pages to apply global settings to the pages.
	CMSCampaignPage	Base page for campaigns.
	CMSContentManagementPage	Base page for the MyDesk pages to apply global settings to the pages.
	CMSContentMessageBoardsPage	Base page for the CMS Content Message Boards modal pages to apply global settings to the pages.
	CMSContentModalPage	Base page for the CMS Content modal pages to apply global settings to the pages.
	CMSContentPage	Base page for the content pages to apply global settings to the pages.
	CMSContentPersonalizationContentPage	Base page for content personalization section.
	CMSConversionPage	Base page for conversions.
	CMSCustomTablesModalPage	Base page for the Custom table modal pages.
	CMSCustomTablesPage	Base page for the Custom table pages.
	CMSCustomTablesToolsPage	Base page for the Custom table pages in the tools section.
	CMSDebugPage	Base page for the debug tab of administration -> system pages to apply global settings to the pages.
	CMSDesignPage	Base page for the design pages.
	CMSDeskPage	Base page for the CMSDesk pages to apply global settings to the pages.
	CMSDeviceProfilesModalPage	Base page for the device profiles modal pages.
	CMSDeviceProfilesPage	Base page for the device profiles pages.
	CMSEcommerceReportsPage	Base page for the E-commerce reports pages.
	CMSEditTemplatePage	Base page for the editing for page template properties.
	CMSEmailTemplatesPage	Base page for the e-mail templates tab of administration pages to apply global settings to the pages.
	CMSEventLogPage	Base page for the event log tab of administration pages to apply global settings to the pages.
	CMSEventManagerPage	Base page for the CMS Event manager pages to apply global settings to the pages.
	CMSForumsPage	Summary description for ForumsPage.
	CMSGroupForumPage	Base page for forums under groups pages.
	CMSGroupMediaLibraryPage	Base page for media library under groups pages.
	CMSGroupMessageBoardsPage	Base page for message boards under groups pages.
	CMSGroupPage	Base page for the CMS Group pages to apply global settings to the pages.
	CMSGroupPollsPage	Base page for polls under groups pages.
	CMSGroupProjectManagementPage	Base class for project management page beneath the community groups.
	CMSGroupRolesPage	Base page for roles under groups pages.
	CMSChatPage	Base page for all Chat pages in CMS Desk Tools.
	CMSChatRoomPage	Base page for Chat pages where room is edited (room -> General, room -> Chat Users, messages, view)
	CMSImportExportPage	Base page for the Import/Export pages.
	CMSIntegrationPage	Base page for the Integration pages.
	CMSLiveMasterPage	Base class for live site master pages.
	CMSLiveModalPage	Summary description for CMSLiveModalPage.
	CMSMacroRulesPage	Base page for Macro rules pages.
	CMSMasterPage	Base class for CMSDesk master pages.
	CMSMediaLibraryModalPage	Base page for the CMS Media library modal pages to apply global settings to the pages.
	CMSMediaLibraryPage	Base page for the CMS Media library pages to apply global settings to the pages.
	CMSMembershipPage	Base class for UI pages of membership.
	CMSMessageBoardBoardsPage	Base page for CMS Message boards - Boards pages.
	CMSMessageBoardMessagesPage	Base page for CMS Message boards - Messages pages.
	CMSMessageBoardPage	Base page for the CMS Message board pages to apply global settings to the pages.
	CMSModalDesignPage	Base page for the design pages.
	CMSModalGlobalAdminPage	Base page classs for the modal pages which should be available for global administrators only.
	CMSModalPage	Summary description for CMSModalPage.
	CMSMVTestPage	Base class for UI pages of MVT test.
	CMSNewsletterPage	Base page for the CMS Newsletter pages to apply global settings to the pages.
	CMSNotificationsPage	Base page for the Notifications pages.
	CMSObjectVersioningPage	Base class for UI pages of object versioning.
	CMSOnlineMarketingContentPage	Base page for On-line Marketing section.
	CMSOnlineMarketingPage	Base class for UI pages of Online marketing.
	CMSPage	Base page for all CMS administration UI pages
	CMSPollsPage	Base page for the CMS Polls pages to apply global settings to the pages.
	CMSPreviewControl	Abstract preview control class
	CMSProjectManagementConfigurationPage	Base page for CMS Project management - Configuration pages.
	CMSProjectManagementPage	Base class for UI pages of Project.
	CMSProjectManagementProjectsPage	Base page for CMS Project management - Projects pages.
	CMSProjectManagementTasksPage	Base page for CMS Project management - Tasks pages.
	CMSPropertiesPage	Base page for the properties pages to apply global settings to the pages.
	CMSReportingModalPage	Base page for the CMS Reporting modal pages to apply global settings to the pages.
	CMSReportingPage	Base page for the CMS Reporting pages to apply global settings to the pages.
	CMSRolesPage	Base page for the roles tab of administration pages to apply global settings to the pages.
	CMSScheduledTasksPage	Base page for the scheduled tasks tab of administration pages to apply global settings to the pages.
	CMSSMTPServersPage	Page for SMTP Servers administration.
	CMSStagingPage	Base page for the Content staging pages.
	CMSToolsModalPage	Base page for the CMS Tools modal pages to apply global settings to the pages.
	CMSToolsPage	Base page for the CMS Tools pages to apply global settings to the pages.
	CMSToolsPageGlobalPermissions	Base page for modules which uses GlobalRead and GlobalModify permissions.
	CMSTranslationServiceModalPage	Base UI class for translation services modal UI pages.
	CMSTranslationServicePage	Base UI class for translation services UI pages.
	CMSTranslationsPage	Base page for the Translation services pages.
	CMSUIPage	Base page class for UI
	CMSUIPersonalizationPage	Base page for the UI personalization tab of administration pages to apply global settings to the pages.
	CMSUserControl	Base class for CMS administration interface control.
	CMSUsersPage	Base page for the users tab of administration pages to apply global settings to the pages.
	CMSValidationPage	Base page for the properties pages to apply global settings to the pages
	CMSVariantDialogPage	Base page for the variant dialog pages.
	CMSWebAnalyticsPage	Base page for the CMS Web analytics pages to apply global settings to the pages.
	CMSWebPartPropertiesPage	Base page for the properties pages to apply global settings to the pages.
	CMSWidgetPropertiesLiveModalPage	Base page for the properties pages to apply global settings to the pages.
	CMSWidgetPropertiesLivePage	Base page for the properties pages to apply global settings to the pages.
	CMSWidgetPropertiesPage	Base page for the properties pages to apply global settings to the pages.
	CMSWorkflowPage	Base page for the workflow pages.
	ContentActionsControl	Control for handling global content actions.
	ContentPage	Base page for all web site (content) pages.
	ContentUrlRetriever	Class for generation content URLs
	ControlsExamplesPage	Base page for the Controls examples pages to apply global settings to the pages.
	DashboardPage	Base class used for dashboard page.
	DesignerPage	Base page for the Designer pages to apply global settings to the pages.
	DevelopmentMode	Panel that displays only if the development mode is enabled
	DirectFileUploader	Base class for direct file uploader controls.
	DocumentBase	Base interface for document pages.
	DocumentFlagsControl	Control for displaying document flags.
	DocumentStylesheetSelector	Form control for the document CSS stylesheet selection.
	DocumentUIHelper	Helper methods for document management UI
	DocumentValidator	Base class for validation controls.
	EditedObjectAttribute	Defines the edited object.
	EmailTemplateTypeSelector	Form control for the email template type selection.
	ErrorMessageControl	Error control for displaying error message on live site.
	EventLogTypeSelector	Form control for the event log type selection.
	ExtendedBoundField	Extended bound field for use within UniGrid.
	ExternalEditControl	Base class for controls which provide external edit action
	ExternalEditHelper	Helper methods for editing of items in external application
	FieldEditorEventArgs	Field editor event args.
	FilesLog	Files log control for debug purposes.
	FileUpload	Base class for file upload controls.
	FriendshipStatusSelector	Form control for the friendship status selection.
	FullForumSelector	Form control the forum selection with (all) option.
	FullMediaLibrarySelector	Form control for the media library selection.
	GenderSelector	Form control for the gender selection.
	GetFileHandler	Base class for GetFile handlers. Handles client caching and range requests.
	GetFilePage	Base page for GetFile pages.
	GlobalAdminPage	Base page classs for the pages which should be available for global administrators only.
	GridViewTemplate	Creates template field in grid view dynamically.
	GroupSelector	Form control for the forum group selection.
	HandlersLog	Handlers log control for debug purposes.
	HashValidationAttribute	Hash validation attribute.
	HelpAttribute	Settings for title of the page.
	HelpControl	Base class for help control.
	CheckLicenceAttribute	Checks the license for the given page.
	ImportExportBase	Base checkBox grid item.
	ImportExportControl	Base import / export control
	ImportExportGridTask	ImportExportGridTask with checkBoxes. Used for tasks import and export.
	ImportExportGridView	ImportExportGridView with checkBoxes. Used for import and export site objects.
	IndexSelector	Form control for the search index selection.
	InformationAttribute	Displays the information on the page.
	ItemProperties	Abstract class that all properties controls should inherit from.
	LicensePackageSelector	Form control for the license package selection.
	LicenseSelector	Form control for the license selection.
	LinkedInCompanySelector	Form control for the Linked-in company selection.
	LinkMediaSelector	Link media selector base class.
	LivePage	Base page for the live site pages to apply global settings to the pages.
	LogControl	Logs control base class.
	MacroBoolExpression	Represents a boolean expression for macro designer control.
	MacroDesignerGroup	Base class for the group of boolean expressions control.
	MacroDesignerTree	Represents a structure of of boolean expressions.
	MacroLog	Query log base class.
	MassActionItem	Represents single mass action displayed in the mass action drop-down list.
	MediaView	View controls base class.
	MessagePage	Base class for the message pages.
	MultipleNotificationGatewaySelector	Form control for the notification gateway selection.
	NewsletterSelectorSimple	Form control for the newsletter selection.
	NotificationTemplateSelector	Form control for the notification template selector.
	ObjectCustomizationPanel	Server control which represents container which handles object columns customization.
	ObjectLockingPanel	Server control which represents container which handles object locking.
	ObjectTransformation	Object transformation control
	ObjectTransformationDataProvider	Object transformation control
	OutputLog	Output log base class.
	PageTitle	PageTitle control base class.
	ParentObjectAttribute	Defines the edited object.
	PortalPage	Base class for the portal page template.
	QueryLog	Query log base class.
	RecaptchaControl	This class encapsulates reCAPTCHA UI and logic into an ASP.NET server control.
	RecaptchaControlDesigner	This class provide designer support code for RecaptchaControl.
	RecaptchaControlDesigner ActionList	Class representing control actions list.
	RecaptchaResponse	Encapsulates a response from reCAPTCHA web service.
	RecaptchaValidator	Calls the reCAPTCHA server to validate the answer to a reCAPTCHA challenge. Normally, you will use the RecaptchaControl class to insert a web control on your page. However
	ReportGraphSelector	Form control for the report graph selection.
	ReportSelector	Form control for the report selection with defining parameters.
	ReportTableSelector	Form control for the report table selection.
	ReportValueSelector	Form control for the report value selection.
	RequestProcessLog	Cache log base class.
	RequireSiteAttribute	Makes the page require the site availability.
	ResourceHandler	Handler that serves minified and compressed resources.
	SaveActionAttribute	Adds save action to the page.
	ScriptAttribute	Adds action to the page.
	SecurityAttribute	Adds breadcrumb to the page.
	SecurityLog	Query log base class.
	SelectBlogName	Form control for the blog selection.
	SelectBoardWithAll	Form control for the message board selection with all option.
	SelectCulture	Form control for the site culture selection.
	SelectHierarchicalTransformation	Form control for the transformation selection.
	SelectPageTemplateCategory	Form control for the page template category selection.
	SelectReport	Form control for the report selection.
	SelectReportCategory	Form control for the report category selection.
	SelectRoles	Form control for the roles selection.
	SelectSettingsCategory	Form control for the settings category selection.
	SelectSinglePath	Form control for the path selection.
	SelectSite	Form control for the site selection.
	SelectSites	Form control for the site selection.
	SelectSiteWithAllForAdmin	Form control for site selection with all for global admin.
	SelectUserName	Form control for the user name selection.
	SelectUsers	Form control for the multiple users selection.
	SelectWebpart	Form control for the web part category selection.
	SelectWidgetCategory	Form control for the widget category selection.
	SettingsGroup	Control representing settings group
	SettingsGroupViewerControl	Base class for SettingsGroupViewer, so it is possible to connect to events on settings page.
	SilverlightApplication	Control for Silverlight application
	SiteCultureSelectorAll	Form control for the site culture selection with (all) option.
	SiteManagerPage	Obsolete. Base page for the CMSSiteManager pages to apply global settings to the pages.
	SiteOrGlobalSelector	Form control for the site selection.
	SupportedCultureSelector	Form control for the supported culture selection.
	TabAttribute	Adds tab to the page.
	TabCreatedEventArgs	Tab created event arguments
	TabsAttribute	Tabs definition.
	TemplateMasterPage	Base class for the template pages.
	TemplatePage	Base class for the ASPX page template pages.
	TimeZoneTypeSelector	Form control for the time zone type selection.
	TitleAttribute	Settings for title of the page.
	TranslationPriority	Form control for translation priority selection.
	TranslationStatus	Form control for translation status selection.
	UIContextDataItemName	Constant names of UIContext.Current items.
	UICultureSelector	Form control for the UI culture selection.
	UIElementAttribute	Checks the license for the given page.
	UIElementLayout	.NET representation of the UI Layout JavaScript plug-in. Adds a footer pane automatically when used in dialogs
	UILayout	.NET representation of the UI Layout JavaScript plug-in
	UILayoutPane	Part of UI layout (can be center or one of cardinal directions).
	UILayoutValue	Class representing key-value. Used for initializing properties of control loaded by UILayoutPane.
	UIMenu	Basic class for UI menu.
	UIPager	Base class for the UI Pager control
	UIPageURLSettings	Configuration class used for building UI page URLs.
	UIPlaceHolder	Server control which represents container for UI element of the page.
	UITabItem	UITab control item.
	UITabs	Server control for rendering tab navigation in administration user interface. Allows to create tabs from module's UI elements.
	UITabsExtender	UITabs Control extender.
	UITabsExtender TControl	UITabs Control extender.
	UIToolbar	Basic class for UI Toolbar menu.
	UniButton	Universal button control
	UniFlatSelector	Uni flat selector base class.
	UniGraph	UniGraph base class.
	UniGraphToolbar	UniGraph toolbar class
	UniGrid	UniGrid base class.
	UniGridExportHelper	Helper for exporting data from UniGrid view
	UniGridFilterField	Represents a field of UniGrid's filter.
	UniGridFunctions	Unigrid functions.
	UniGridHelper	Provides helper methods for UniGrid controls.
	UniGridTransformations	UniGrid built-in transformations
	UniMatrix	UniMatrix base class.
	UniMenuArgs	UniMenu event arguments
	UniSelector	Uni selector base class.
	UniTree	Uni tree base class.
	UniTreeGetImageHandler	Uni tree get image handler
	UniTreeImageArgs	Arguments for the UniTree's OnGetImage event handler
	UniTreeNode	Universal site map tree node.
	UniTreeProvider	Universal sitemap tree provider.
	UrlSelector	Form control for the URL selection.
	ValuesTable	Values table base class.
	VersionHistoryControl	Base history version control.
	ViewBadgeImage	Form control for view integer number.
	ViewBadgeText	Form control for view badge text.
	ViewDate	Form control for view date.
	ViewGroupAccess	Form control for view group access.
	ViewGroupAvatar	Form control for view group avatar.
	ViewInteger	Form control for view integer number.
	ViewSecureText	Form control for view secure text.
	ViewStateLog	View state log control for debug purposes.
	ViewUserAvatar	Form control for view user avatar.
	ViewUserGender	Form control for view user gender.
	WebFarmLog	Query log base class.
	XMLPage	Page producing XML output.

Interfaces

	Interface	Description
	ICMSAttribute	Basic interface for all attributes.
	ICMSFunctionalAttribute	Security attribute interface.
	ICMSMasterPage	Interface for CMS master pages.
	ICMSModalMasterPage	Interface for modal master pages.
	ICMSSecurityAttribute	Security attribute interface.
	IDataUserControl	DataUserControl interface
	IExtensibleMassActions	Defines contract foreign modules can use to add new mass actions.
	IExtensibleUniGrid	Specifies contract which can be used to extend UniGrid from the outside.
	IFieldEditorControl	Used for loading / updating configuration of the control from the field editor parameters.
	IUIElementControl	Class representing UI element control.
	IUniGrid	Empty interface for identify UniGrid in UIControls.
	IUserFilter	User filter interface

Delegates

	Delegate	Description
	AfterItemDeletedEventHandler	Action event handler fired when form item was deleted.
	AsyncAction	Action event delegate.
	BeforeEventHandler	Before event handler.
	BeforeRenderEventHandler	Before event handler.
	CMSAdminControl CheckPermissionsEventHandler	Delegate of event fired when permissions should be checked.
	CMSAdminControl CheckPermissionsExtendedEventHandler	Delegate of event fired when permissions should be checked.
	CMSAdminControl NotAllowedEventHandler	Delegate of event fired when action is not allowed.
	CreateUrlDelegate	Delegate defining method which is used to create URL of the mass action which will be later used to redirect page or open modal dialog.
	MediaView OnListReloadRequired	Delegate for the event fired when UniGrid's page changed.
	OnActionEventHandler	Action event handler.
	OnAfterDataReload	On after data reloading event handler.
	OnAfterRetrieveData	On after retrieve data handler.
	OnBeforeDataReload	On before data reloading event handler.
	OnBeforeFiltering	On before unigrid filtering event handler.
	OnBeforeSorting	On before unigrid sorting event handler.
	OnDataReloadEventHandler	Data reloading event handler.
	OnExternalDataBoundEventHandler	External data binding event handler.
	OnFieldCreatedEventHandler	Action event handler for new field creation.
	OnFieldNameChangedEventHandler	Action event handler fired when field name was changed.
	OnFilterFieldCreated	On after filter field created handler.
	OnLoadColumns	On columns load event handler.
	OnPageSizeChanged	On page size change event handler.
	RenderEventHandler	Before event handler.
	UIMenu NodeCreatedEventHandler	Node created delegate.
	UIPlaceHolder OnIsHiddenDelegate	OnIsHidden delegate
	UITabs CheckTabSecurityEventHandler	Security check delegate.
	UITabs TabCreatedEventHandler	Tab creation delegate.
	UITabs TabsLoadedEventHandler	Delegate for event raised after tabs are created.
	UIToolbar ButtonCreatedEventHandler	Button created delegate.
	UIToolbar ButtonFilterEventHandler	Button filtered delegate.
	UIToolbar GroupFilterEventHandler	Group filtered delegate.
	UIToolbar GroupsCreatedEventHandler	Groups created delegate.
	UniFlatSelector ItemSearch	On search delegate.
	UniFlatSelector ItemSelectedEventHandler	On selected item delegate.
	UniMatrix GetRowItemCssClassEventHandler	Check if additional CSS class should be rendered for current row event.
	UniMatrix ItemChangedEventHandler	Item changed event.
	UniSelector AdditionalDataBoundEventHandler	Delegate for additional data bound event.
	UniSelector ListItemCreated	Delegate used for manipulation with items title.
	UniTree ItemSelectedEventHandler	On selected item event handler.
	UniTree NodeCreatedEventHandler	Node created delegate.

Enumerations

	Enumeration	Description
	AsyncWorkerStatusEnum	Async worker status enumeration.
	ControlDisplayModeEnum	Display mode of the control.
	FieldEditorModeEnum	Field editor data mode.
	FieldEditorSelectedItemEnum	Type of selected item.
	FileTypeEnum	WebDAV control enumeration.
	ListingTypeEnum	Type of documents to show in my desk.
	LoadModeEnum	Defines when the UI Layout JavaScript plug-in should be initialized.
	MassActionScopeEnum	Specifies the scope mass action will be used for.
	MassActionTypeEnum	Type of action which will be performed when performing the mass action.
	MultifileUploaderModeEnum	Specifying multifile uploader upload modes.
	NewClassWizardModeEnum	New class wizzard modes.
	PaneDirectionEnum	Defines location of the pane. It can be one of cardinal directions or center.
	SelectionModeEnum	Selection modes enumeration.
	TextCompareOperatorEnum	Specifies possible operators for comparing text (used mostly in CMSFormControls/Filters/TextFilter control).
	UIElementTypeEnum	UI element type
	UniGridFilterTypeEnum	Unigrid filter types enumeration.
	UserContributionAllowUserEnum	User contribution allow user enumeration.