RichImageField Class


Field control object that you can use to edit data in ImageField type fields.

public ref class RichImageField : Microsoft::SharePoint::Publishing::WebControls::BaseRichUrlField
public class RichImageField : Microsoft.SharePoint.Publishing.WebControls.BaseRichUrlField
type RichImageField = class
    inherit BaseRichUrlField
Public Class RichImageField
Inherits BaseRichUrlField


This field control is used in page layouts and on list edit forms to display and modify the item values of any SPListItem.Fields objects with the publishing ImageField type.



Creates a new instance of a RichImageField control object.


strShowSearchFormKey (Inherited from SPControl)
textBox (Inherited from BaseTextField)



Gets or sets the constraint to enable external URLs in the HTML when validating the value in this field.

(Inherited from BaseRichUrlField)
AllowFirstFocus (Inherited from BaseFieldControl)

Gets or sets the constraint that allows hyperlinks to be added to the HTML.

AlternateTemplate (Inherited from TemplateBasedControl)
AlternateTemplateName (Inherited from TemplateBasedControl)
CanCacheRenderedFieldValue (Inherited from BaseFieldControl)

Gets the selector control used in ControlMode.

(Inherited from BaseRichUrlField)
ComponentRequiresPostback (Inherited from BaseFieldControl)
ControlMode (Inherited from FormComponent)
Controls (Inherited from TemplateBasedControl)
ControlTemplate (Inherited from TemplateBasedControl)
CssClass (Inherited from BaseTextField)
CustomAlternateTemplate (Inherited from TemplateBasedControl)
CustomTemplate (Inherited from TemplateBasedControl)
DefaultAlternateTemplateName (Inherited from TemplateBasedControl)

Gets or sets the URL to a location in this site collection that is added to the top of the "Look In" section of the Asset Picker dialog box when selecting an image source URL.


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)

Default template name for this control.

DisableInputFieldLabel (Inherited from BaseFieldControl)

If this property is set to an integer greater than 0, the ImageFieldValue.Height property is forced to this value.

DisplaySize (Inherited from FieldMetadata)
DisplayTemplate (Inherited from BaseFieldControl)
DisplayTemplateName (Inherited from BaseFieldControl)

If this property is set to an integer greater than 0, the ImageFieldValue.Width property is forced to this value.

EnableInputFieldLabels (Inherited from FormComponent)
ErrorMessage (Inherited from BaseFieldControl)

Expected class of the child control used in Edit mode with this field control.


Expected subclass of the SPField object in the SPListItem object for the FieldName.

Field (Inherited from FieldMetadata)
FieldName (Inherited from FieldMetadata)
Fields (Inherited from FormComponent)
HandleTextField (Inherited from BaseTextField)
HasPostBackEditData (Inherited from BaseFieldControl)
HiddenInput (Inherited from RichTextField)
HideWikiLabel (Inherited from RichTextField)
InDesign (Inherited from SPControl)
InputFieldLabel (Inherited from BaseFieldControl)
IsClientRenderedForm (Inherited from FormComponent)
IsEditMode (Inherited from FormComponent)
IsFieldValueCached (Inherited from BaseFieldControl)
IsInDesignTimeMode (Inherited from BaseFieldControl)
IsInInlineEditMode (Inherited from BaseFieldControl)
IsValid (Inherited from BaseFieldControl)
Item (Inherited from FormComponent)
ItemContext (Inherited from FormComponent)
ItemFieldValue (Inherited from BaseFieldControl)
ItemId (Inherited from FormComponent)
ItemIdAsString (Inherited from FormComponent)
List (Inherited from FormComponent)
ListFormWP (Inherited from FormComponent)
ListId (Inherited from FormComponent)
ListItem (Inherited from FormComponent)
ListItemFieldValue (Inherited from BaseFieldControl)
PageUri (Inherited from SPControl)
PreviousControlMode (Inherited from BaseFieldControl)
RecurrenceID (Inherited from FormComponent)
RedirectUrl (Inherited from FormComponent)
RegisterAs (Inherited from SPControl)
RenderContext (Inherited from TemplateBasedControl)

Gets or sets the ID of a valid image rendition of the site collection.

RibbonCommand (Inherited from FormComponent)
RibbonContextualGroupCommand (Inherited from FormComponent)
RibbonGroupCommand (Inherited from FormComponent)
RibbonTabCommand (Inherited from FormComponent)
TabIndex (Inherited from BaseFieldControl)
Template (Inherited from TemplateBasedControl)
TemplateContainer (Inherited from TemplateBasedControl)
TemplateName (Inherited from TemplateBasedControl)
TemplateOverride (Inherited from TemplateBasedControl)

Represent the text string representation of this field.

(Inherited from BaseRichUrlField)

Returns the client ID of the rich text container.

(Inherited from BaseRichField)

The current ImageFieldValue object in this field control in edit mode.

Version (Inherited from TemplateBasedControl)
Visible (Inherited from NoteField)
Web (Inherited from TemplateBasedControl)



This member is reserved for internal use and is not intended to be used directly from your code.

(Inherited from BaseRichField)
Focus() (Inherited from RichTextField)
GetDesignTimeHtml() (Inherited from SPControl)
OnInit(EventArgs) (Inherited from BaseFieldControl)
OnLoad(EventArgs) (Inherited from RichTextField)
OnPreRender(EventArgs) (Inherited from RichTextField)

Populate the properties of the child edit control, often based on the SPField schema or the properties of this control.

RegisterFieldControl() (Inherited from BaseFieldControl)

This member is reserved for internal use and is not intended to be used directly from your code.

(Inherited from BaseRichField)
RenderFieldForDisplay(HtmlTextWriter) (Inherited from RichTextField)
RenderFieldForInput(HtmlTextWriter) (Inherited from RichTextField)
RenderHtmlForDisplay(HtmlTextWriter, String) (Inherited from RichTextField)
RenderHtmlForInput(HtmlTextWriter, String) (Inherited from RichTextField)
RenderValidationMessage(HtmlTextWriter) (Inherited from BaseFieldControl)
UpdateFieldValueInItem() (Inherited from BaseFieldControl)

Validate the content that is posted to this control.

Explicit Interface Implementations

IDesignerEventAccessor.OnDesignerLoad(EventArgs) (Inherited from SPControl)
IDesignerEventAccessor.OnDesignerPreRender(EventArgs) (Inherited from SPControl)

Applies to