Export (0) Print
Expand All

SiteElementControl members

SharePoint 2013

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.

  Name Description
Public method SiteElementControl Initializes a new instance of a SiteElementControl object.
Top

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

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

  Name Description
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)
Top

  Name Description
Protected field textBox (Inherited from BaseTextField.)
Top

Community Additions

ADD
Show:
© 2014 Microsoft