C# Class SenseNet.Portal.UI.Controls.FieldControl

Inheritance: ViewControlBase, INamingContainer, IFieldControl
Datei anzeigen Open project: maxpavlov/FlexNet Class Usage Examples

Protected Properties

Property Type Description
DescriptionControlID string
InnerControlID string
InputUnitPanelID string
RequiredControlID string
TitleControlID string
_container System.Web.UI.Control
_field SenseNet.ContentRepository.Field
_fieldName string

Private Properties

Property Type Description
AddGlobalTemplate void
AddLocalTemplate void
AddTemplateTo void
InstantiateErrorTemplate void

Public Methods

Method Description
ClearError ( ) : void

Clears the error message.

DoAutoConfigure ( FieldSetting setting ) : void
GetData ( ) : object

Gets object data.

Exception handling and displayed is done at ContentView level; FormatExceptions and Exceptions are handled and displayed at this level. Should you need custom or localized error messages, throw a FieldControlDataException with your own error message.

GetOutputData ( OutputMethod method ) : string
RenderBeginTag ( System.Web.UI.HtmlTextWriter writer ) : void

Renders the beginning of the control

The opening tag of the wrapping container, Title and Description are rendered but not the control itself.

RenderEndTag ( System.Web.UI.HtmlTextWriter writer ) : void

Renders the end part of the control

Tags left open in RenderBeginTag are closed.

RenderFieldDescription ( System.Web.UI.HtmlTextWriter writer ) : void

Renders the description of the FieldControl.

RenderFieldTitle ( System.Web.UI.HtmlTextWriter writer ) : void

Renders the title of the FieldControl.

SetData ( object data ) : void

Sets data within the FieldControl

SetErrorMessage ( string message ) : void

Sets the error message

Protected Methods

Method Description
FieldControl ( ) : System
GetInputUnitPanel ( ) : System.Web.UI.HtmlControls.HtmlGenericControl
GetRequiredControl ( ) : Control
InitTemplates ( ) : void
OnInit ( EventArgs e ) : void
OnLoad ( EventArgs e ) : void
Render ( System.Web.UI.HtmlTextWriter writer ) : void

Renders the control

RenderErrorMessage ( System.Web.UI.HtmlTextWriter writer ) : void

Renders the error message

SetDataInternal ( ) : void
ShowErrorMessage ( ) : void

Shows the error message.

Private Methods

Method Description
AddGlobalTemplate ( string fieldControlName ) : void
AddLocalTemplate ( Control target, System.Web.UI.ControlCollection owner, ITemplate source, bool addErrorTemplate ) : void
AddTemplateTo ( Control target, System.Web.UI.ControlCollection owner, ITemplate source, bool addErrorTemplate ) : void
InstantiateErrorTemplate ( ) : void

Instantiates the error template.

Method Details

ClearError() public method

Clears the error message.
public ClearError ( ) : void
return void

DoAutoConfigure() public method

public DoAutoConfigure ( FieldSetting setting ) : void
setting FieldSetting
return void

FieldControl() protected method

protected FieldControl ( ) : System
return System

GetData() public abstract method

Gets object data.
Exception handling and displayed is done at ContentView level; FormatExceptions and Exceptions are handled and displayed at this level. Should you need custom or localized error messages, throw a FieldControlDataException with your own error message.
public abstract GetData ( ) : object
return object

GetInputUnitPanel() protected method

protected GetInputUnitPanel ( ) : System.Web.UI.HtmlControls.HtmlGenericControl
return System.Web.UI.HtmlControls.HtmlGenericControl

GetOutputData() public method

public GetOutputData ( OutputMethod method ) : string
method OutputMethod
return string

GetRequiredControl() protected method

protected GetRequiredControl ( ) : Control
return System.Web.UI.Control

InitTemplates() protected method

protected InitTemplates ( ) : void
return void

OnInit() protected method

protected OnInit ( EventArgs e ) : void
e System.EventArgs
return void

OnLoad() protected method

protected OnLoad ( EventArgs e ) : void
e System.EventArgs
return void

Render() protected method

Renders the control
protected Render ( System.Web.UI.HtmlTextWriter writer ) : void
writer System.Web.UI.HtmlTextWriter
return void

RenderBeginTag() public method

Renders the beginning of the control
The opening tag of the wrapping container, Title and Description are rendered but not the control itself.
public RenderBeginTag ( System.Web.UI.HtmlTextWriter writer ) : void
writer System.Web.UI.HtmlTextWriter
return void

RenderEndTag() public method

Renders the end part of the control
Tags left open in RenderBeginTag are closed.
public RenderEndTag ( System.Web.UI.HtmlTextWriter writer ) : void
writer System.Web.UI.HtmlTextWriter
return void

RenderErrorMessage() protected method

Renders the error message
protected RenderErrorMessage ( System.Web.UI.HtmlTextWriter writer ) : void
writer System.Web.UI.HtmlTextWriter
return void

RenderFieldDescription() public method

Renders the description of the FieldControl.
public RenderFieldDescription ( System.Web.UI.HtmlTextWriter writer ) : void
writer System.Web.UI.HtmlTextWriter
return void

RenderFieldTitle() public method

Renders the title of the FieldControl.
public RenderFieldTitle ( System.Web.UI.HtmlTextWriter writer ) : void
writer System.Web.UI.HtmlTextWriter
return void

SetData() public abstract method

Sets data within the FieldControl
public abstract SetData ( object data ) : void
data object Data of the Field wrapped
return void

SetDataInternal() protected method

protected SetDataInternal ( ) : void
return void

SetErrorMessage() public method

Sets the error message
public SetErrorMessage ( string message ) : void
message string Error message to be set
return void

ShowErrorMessage() protected method

Shows the error message.
protected ShowErrorMessage ( ) : void
return void

Property Details

DescriptionControlID protected_oe property

protected string DescriptionControlID
return string

InnerControlID protected_oe property

protected string InnerControlID
return string

InputUnitPanelID protected_oe property

protected string InputUnitPanelID
return string

RequiredControlID protected_oe property

protected string RequiredControlID
return string

TitleControlID protected_oe property

protected string TitleControlID
return string

_container protected_oe property

protected Control,System.Web.UI _container
return System.Web.UI.Control

_field protected_oe property

The Field wrapped by the FieldControl
protected Field,SenseNet.ContentRepository _field
return SenseNet.ContentRepository.Field

_fieldName protected_oe property

Name of the field that the FieldControl maps to
protected string _fieldName
return string