SiteElementControl members

Represents the Site Elements control that is used to render master page elements such as a header or a footer.

The SiteElementControl type exposes the following members.

Constructors

	Name	Description
	SiteElementControl	Initializes a new instance of a SiteElementControl object.

Top

Properties

	Name	Description
	Adapter	(Inherited from Control.)
	AllowDragDrop	Gets or sets a Boolean value that indicates if the drag and drop of elements is supported for the field. (Inherited from RichHtmlField.)
	AllowEmbedding	Gets or sets a constraint that enables embedding (IFrames) to be added when editing the field. (Inherited from RichHtmlField.)
	AllowExternalUrls	Gets or sets the constraint that allows external URLs in the HTML when validating the value in this RichHtmlField object. (Inherited from RichHtmlField.)
	AllowFirstFocus	(Inherited from BaseFieldControl.)
	AllowFontColorsMenu	Gets or sets a Boolean value that indicates if a font colors menu is shown. (Inherited from RichHtmlField.)
	AllowFontCustomColors	Gets or sets a Boolean value that indicates if font custom colors are shown. (Inherited from RichHtmlField.)
	AllowFonts	Gets or sets the constraint that allows font element tags to be added to the HTML. (Inherited from RichHtmlField.)
	AllowFontSizesMenu	Gets or sets a Boolean value that indicates if a font size menu is enabled. (Inherited from RichHtmlField.)
	AllowFontsMenu	Gets or sets a Boolean value that indicates if a fonts menu is enabled. (Inherited from RichHtmlField.)
	AllowFontStandardColors	Gets or sets a Boolean value that indicates if font standard colors are shown. (Inherited from RichHtmlField.)
	AllowFontStandardSizes	Gets or sets a Boolean value that indicates if font standard sizes are enabled. (Inherited from RichHtmlField.)
	AllowFontThemeColors	Gets or sets a Boolean value that indicates if font theme colors are shown. (Inherited from RichHtmlField.)
	AllowHeadings	Gets or sets the constraint that allows heading tags to be added to the HTML. (Inherited from RichHtmlField.)
	AllowHtmlSourceEditing	Gets or sets whether you can switch the HtmlEditor object into a mode where the HTML can be edited directly. (Inherited from RichHtmlField.)
	AllowHyperlinks	Gets or sets the constraint that allows hyperlinks to be added to the HTML. (Inherited from RichHtmlField.)
	AllowImageFormatting	Gets or sets image formatting items. (Inherited from RichHtmlField.)
	AllowImagePositioning	Gets or sets the position of the image. (Inherited from RichHtmlField.)
	AllowImages	Gets or sets the constraint that allows image tags to be added to the HTML. (Inherited from RichHtmlField.)
	AllowImageStyles	Gets or sets whether the Table Styles menu is enabled. (Inherited from RichHtmlField.)
	AllowInsert	Gets or sets whether Insert options are shown. (Inherited from RichHtmlField.)
	AllowLists	Gets or sets the constraint that allows list tags to be added to the HTML. (Inherited from RichHtmlField.)
	AllowParagraphFormatting	Gets or sets whether paragraph formatting items are enabled. (Inherited from RichHtmlField.)
	AllowReusableContent	Gets or sets the flag that enables the reusable content picker button when editing this field. (Inherited from RichHtmlField.)
	AllowStandardFonts	Gets or sets whether standard fonts are enabled. (Inherited from RichHtmlField.)
	AllowStyles	Gets or sets whether the style menu is enabled. (Inherited from RichHtmlField.)
	AllowTables	Gets or sets the constraint that allows table handling tags to be added to the HTML. (Inherited from RichHtmlField.)
	AllowTableStyles	Gets or sets whether the Table Styles menu is enabled. (Inherited from RichHtmlField.)
	AllowTextMarkup	Gets or sets the constraint that allows explicit text markup tags, such as bold and italic, to be added to the HTML. (Inherited from RichHtmlField.)
	AllowThemeFonts	Gets or sets whether theme fonts are enabled. (Inherited from RichHtmlField.)
	AlternateTemplate	(Inherited from TemplateBasedControl.)
	AlternateTemplateName	(Inherited from TemplateBasedControl.)
	AppRelativeTemplateSourceDirectory	(Inherited from Control.)
	BindingContainer	(Inherited from Control.)
	CanCacheRenderedFieldValue	(Inherited from BaseFieldControl.)
	ChildControlsCreated	(Inherited from Control.)
	ChildHtmlEditor	Gets the HtmlEditor control used in ControlMode.Edit that allows users to edit the content of this control. (Inherited from RichHtmlField.)
	ClientID	(Inherited from Control.)
	ClientIDMode	(Inherited from Control.)
	ClientIDSeparator	(Inherited from Control.)
	ComponentRequiresPostback	(Inherited from BaseFieldControl.)
	Context	(Inherited from Control.)
	ControlMode	(Inherited from FormComponent.)
	Controls	(Inherited from TemplateBasedControl.)
	ControlTemplate	(Inherited from TemplateBasedControl.)
	CssClass	(Inherited from BaseTextField.)
	CustomAlternateTemplate	(Inherited from TemplateBasedControl.)
	CustomTemplate	(Inherited from TemplateBasedControl.)
	DataItemContainer	(Inherited from Control.)
	DataKeysContainer	(Inherited from Control.)
	DefaultAlternateTemplateName	(Inherited from TemplateBasedControl.)
	DefaultAssetImageLocation	Gets or sets the URL to a location in this site collection that will be added to the top of the Look In section of the Asset Picker dialog box when selecting an image source URL. (Inherited from RichHtmlField.)
	DefaultAssetLocation	Gets or sets the server-relative URL string to the default location in SharePoint Server from which to add links to this control. (Inherited from BaseRichField.)
	DefaultPasteModeResolver	(Inherited from RichTextField.)
	DefaultTemplateName	Gets the default template name for this control. (Inherited from RichHtmlField.)
	DesignMode	(Inherited from Control.)
	DisableBasicFormattingButtons	Gets or sets a value that indicates whether basic formatting buttons are enabled or disabled. (Inherited from RichHtmlField.)
	DisableCustomStyles	Gets or sets a value that indicates whether custom styles are enabled or disabled. (Inherited from RichHtmlField.)
	DisableInputFieldLabel	(Inherited from BaseFieldControl.)
	DisplaySize	(Inherited from FieldMetadata.)
	DisplayTemplate	(Inherited from BaseFieldControl.)
	DisplayTemplateName	(Inherited from BaseFieldControl.)
	EditorBackgroundColor	Gets or sets the HTML Editor control's editing mode background color. (Inherited from RichHtmlField.)
	EnableExtensions	Gets or sets a value that indicates whether extensions are enabled for this RichHtmlField object. (Inherited from RichHtmlField.)
	EnableInputFieldLabels	Gets whether a site element control uses field labels. (Overrides FormComponent.EnableInputFieldLabels.)
	EnableTheming	(Inherited from Control.)
	EnableViewState	(Inherited from Control.)
	ErrorMessage	(Inherited from BaseFieldControl.)
	Events	(Inherited from Control.)
	ExpectedEditControlClassType	Gets the expected class of the child control used in Edit mode with this field control. (Inherited from RichHtmlField.)
	ExpectedSPFieldClassType	Gets the expected derived class of the SPField object in the SPListItem object for the FieldName object. (Inherited from RichHtmlField.)
	Field	Gets the underlying SPField object to be rendered by the SiteElementControl object. (Overrides FieldMetadata.Field.)
	FieldName	Gets or sets the name of the field in the site element item to be rendered by a SiteElementControl object.
	Fields	(Inherited from FormComponent.)
	HandleTextField	(Inherited from BaseTextField.)
	HasChildViewState	(Inherited from Control.)
	HasInitialFocus	Gets or sets whether this rich text field should have the initial focus. (Inherited from RichHtmlField.)
	HasPostBackEditData	(Inherited from BaseFieldControl.)
	HiddenInput	Gets or sets the hidden input form field where the field stores its data. (Inherited from RichHtmlField.)
	HideWikiLabel	(Inherited from RichTextField.)
	Html	Gets or sets the current HTML value in the edit control of the field control. (Inherited from RichHtmlField.)
	ID	(Inherited from Control.)
	IdSeparator	(Inherited from Control.)
	InDesign	(Inherited from SPControl.)
	InputFieldLabel	Gets the label of the SiteElementControl object in design mode. (Overrides BaseFieldControl.InputFieldLabel.)
	IsChildControlStateCleared	(Inherited from Control.)
	IsClientRenderedForm	(Inherited from FormComponent.)
	IsEditMode	Gets whether the site element control is in edit mode. (Overrides FormComponent.IsEditMode.)
	IsFieldValueCached	(Inherited from BaseFieldControl.)
	IsInDesignTimeMode	(Inherited from BaseFieldControl.)
	IsInInlineEditMode	(Inherited from BaseFieldControl.)
	IsTrackingViewState	(Inherited from Control.)
	IsValid	(Inherited from BaseFieldControl.)
	IsViewStateEnabled	(Inherited from Control.)
	Item	(Inherited from FormComponent.)
	ItemContext	(Inherited from FormComponent.)
	ItemFieldValue	Gets the value of the field from the cached site element item. (Overrides RichHtmlField.ItemFieldValue.)
	ItemId	(Inherited from FormComponent.)
	ItemIdAsString	(Inherited from FormComponent.)
	List	(Inherited from FormComponent.)
	ListFormWP	(Inherited from FormComponent.)
	ListId	(Inherited from FormComponent.)
	ListItem	Gets the SPListItem the control refers to. (Overrides FormComponent.ListItem.)
	ListItemFieldValue	(Inherited from BaseFieldControl.)
	LoadViewStateByID	(Inherited from Control.)
	MinimumEditHeight	Gets or sets the minimum height that the HTML editor should have when in edit mode. (Inherited from RichHtmlField.)
	NamingContainer	(Inherited from Control.)
	Page	(Inherited from Control.)
	PageUri	(Inherited from SPControl.)
	Parent	(Inherited from Control.)
	PopupEditorMode	Gets or sets a flag that determines whether to use the editor inline or open it in a pop-up window. (Inherited from RichHtmlField.)
	PrefixStyleSheet	Gets or sets the HtmlEditor style sheet prefix. (Inherited from RichHtmlField.)
	PreviewValueSize	Gets or sets the size of the preview value that is used for this field. (Inherited from RichHtmlField.)
	PreviousControlMode	(Inherited from BaseFieldControl.)
	RecurrenceID	(Inherited from FormComponent.)
	RedirectUrl	(Inherited from FormComponent.)
	RegisterAs	(Inherited from SPControl.)
	RenderContext	(Inherited from TemplateBasedControl.)
	RenderingCompatibility	(Inherited from Control.)
	RibbonCommand	(Inherited from FormComponent.)
	RibbonContextualGroupCommand	(Inherited from FormComponent.)
	RibbonGroupCommand	(Inherited from FormComponent.)
	RibbonTabCommand	(Inherited from FormComponent.)
	Site	(Inherited from Control.)
	SkinID	(Inherited from Control.)
	StyleSheet	Gets or sets the prefix for the HTML style sheet. (Inherited from RichHtmlField.)
	TabIndex	(Inherited from BaseFieldControl.)
	Template	(Inherited from TemplateBasedControl.)
	TemplateContainer	(Inherited from TemplateBasedControl.)
	TemplateControl	(Inherited from Control.)
	TemplateName	(Inherited from TemplateBasedControl.)
	TemplateOverride	(Inherited from TemplateBasedControl.)
	TemplateSourceDirectory	(Inherited from Control.)
	Text	Gets or sets the current HTML field text. (Inherited from RichHtmlField.)
	UniqueID	(Inherited from Control.)
	UseInlineStyle	Gets or sets whether to use inline styles instead of classes. (Inherited from RichHtmlField.)
	V4RTEClientId	Gets or sets the client ID of the rich text editor area. (Inherited from RichHtmlField.)
	Value	Current string value of the HTML in this field control in Edit mode. (Inherited from RichHtmlField.)
	Version	(Inherited from TemplateBasedControl.)
	ViewState	(Inherited from Control.)
	ViewStateIgnoresCase	(Inherited from Control.)
	ViewStateMode	(Inherited from Control.)
	Visible	(Inherited from NoteField.)
	Web	(Inherited from TemplateBasedControl.)

Top

Methods

	Name	Description
	AddedControl	(Inherited from Control.)
	AddParsedSubObject	(Inherited from Control.)
	ApplyStyleSheetSkin	(Inherited from Control.)
	BuildProfileTree	(Inherited from Control.)
	ClearCachedClientID	(Inherited from Control.)
	ClearChildControlState	(Inherited from Control.)
	ClearChildState	(Inherited from Control.)
	ClearChildViewState	(Inherited from Control.)
	ClearEffectiveClientIDMode	(Inherited from Control.)
	CreateChildControls	This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from BaseRichField.)
	CreateControlCollection	(Inherited from Control.)
	DataBind()	(Inherited from Control.)
	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 RichTextField.)
	GetDesignModeState	(Inherited from Control.)
	GetDesignTimeHtml	(Inherited from SPControl.)
	GetHashCode	(Inherited from Object.)
	GetRouteUrl(Object)	(Inherited from Control.)
	GetRouteUrl(RouteValueDictionary)	(Inherited from Control.)
	GetRouteUrl(String, Object)	(Inherited from Control.)
	GetRouteUrl(String, RouteValueDictionary)	(Inherited from Control.)
	GetType	(Inherited from Object.)
	GetUniqueIDRelativeTo	(Inherited from Control.)
	HasControls	(Inherited from Control.)
	HasEvents	(Inherited from Control.)
	IsLiteralContent	(Inherited from Control.)
	LoadControlState	(Inherited from Control.)
	LoadViewState	(Inherited from Control.)
	MapPathSecure	(Inherited from Control.)
	MemberwiseClone	(Inherited from Object.)
	OnBubbleEvent	(Inherited from Control.)
	OnDataBinding	(Inherited from Control.)
	OnInit	(Overrides RichHtmlField.OnInit(EventArgs).)
	OnLoad	(Overrides RichHtmlField.OnLoad(EventArgs).)
	OnPreRender	(Overrides RichHtmlField.OnPreRender(EventArgs).)
	OnUnload	(Inherited from Control.)
	OpenFile	(Inherited from Control.)
	PopulateEditControlFields	Populates the properties of the child edit control based on properties of this control. (Inherited from RichHtmlField.)
	RaiseBubbleEvent	(Inherited from Control.)
	RegisterFieldControl	(Inherited from BaseFieldControl.)
	RemovedControl	(Inherited from Control.)
	Render	(Overrides RichHtmlField.Render(HtmlTextWriter).)
	RenderChildren	(Inherited from Control.)
	RenderControl(HtmlTextWriter)	(Inherited from Control.)
	RenderControl(HtmlTextWriter, ControlAdapter)	(Inherited from Control.)
	RenderFieldForDisplay	Override to allow render pattern to show a short message and to allow the field control to show the full HTML value. (Inherited from RichHtmlField.)
	RenderFieldForInput	(Inherited from RichTextField.)
	RenderHtmlForDisplay	(Inherited from RichTextField.)
	RenderHtmlForInput	(Inherited from RichTextField.)
	RenderValidationMessage	(Inherited from BaseFieldControl.)
	ResolveAdapter	(Inherited from Control.)
	ResolveClientUrl	(Inherited from Control.)
	ResolveUrl	(Inherited from Control.)
	SaveControlState	(Inherited from Control.)
	SaveViewState	(Inherited from Control.)
	SetDesignModeState	(Inherited from Control.)
	SetRenderMethodDelegate	(Inherited from Control.)
	ToString	(Inherited from Object.)
	TrackViewState	(Inherited from Control.)
	UpdateFieldValueInItem	Overridden to handle additional tracking properties. (Inherited from RichHtmlField.)
	Validate	Validates the content posted to this control. (Inherited from RichHtmlField.)

Top

Events

	Name	Description
	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

Fields

	Name	Description
	textBox	(Inherited from BaseTextField.)

Top

Explicit interface implementations

	Name	Description
	IParserAccessor.AddParsedSubObject	(Inherited from Control.)
	IControlBuilderAccessor.ControlBuilder	(Inherited from Control.)
	IDataBindingsAccessor.DataBindings	(Inherited from Control.)
	IExpressionsAccessor.Expressions	(Inherited from Control.)
	IControlDesignerAccessor.GetDesignModeState	(Inherited from Control.)
	IDataBindingsAccessor.HasDataBindings	(Inherited from Control.)
	IExpressionsAccessor.HasExpressions	(Inherited from Control.)
	IDesignerEventAccessor.OnDesignerLoad	(Inherited from SPControl.)
	IDesignerEventAccessor.OnDesignerPreRender	(Inherited from SPControl.)
	IControlDesignerAccessor.SetDesignModeState	(Inherited from Control.)
	IControlDesignerAccessor.SetOwnerControl	(Inherited from Control.)
	IControlDesignerAccessor.UserData	(Inherited from Control.)

Top

See also

Reference

SiteElementControl class

Microsoft.SharePoint.Publishing.WebControls namespace