Class TPanel
Direct Known Sub-classes:
TPanel class
TPanel represents a component that acts as a container for other component. It is especially useful when you want to generate components programmatically or hide/show a group of components. By default, TPanel displays a <div> element on a page. Children of TPanel are displayed as the body content of the element. The property Wrap can be used to set whether the body content should wrap or not. HorizontalAlign governs how the content is aligned horizontally, and Direction indicates the content direction (left to right or right to left). You can set BackImageUrl to give a background image to the panel, and you can ste GroupingText so that the panel is displayed as a field set with a legend text. Finally, you can specify a default button to be fired when users press 'return' key within the panel by setting the DefaultButton property.
Constants Inherited From TControl |
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID,
|
Method Summary |
protected
void
|
Adds attributes to renderer.
|
protected
TPanelStyle
|
Creates a style object to be used by the control.
|
string
|
|
string
|
|
string
|
|
string
|
|
string
|
|
string
|
|
protected
string
|
|
boolean
|
|
void
|
Renders the openning tag for the control (including attributes)
|
void
|
Renders the closing tag for the control
|
void
|
Sets the URL of the background image for the panel component.
|
void
|
Specifies the default button for the panel.
|
void
|
|
void
|
|
void
|
Sets the horizontal alignment of the contents within the panel.
|
void
|
|
void
|
Sets the value indicating whether the content wraps within the panel.
|
Methods Inherited From TWebControl |
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
|
Methods Inherited From TControl |
TControl::addedControl(), TControl::addParsedObject(), TControl::addToPostDataLoader(), TControl::applyStyleSheetSkin(), TControl::autoBindProperty(), TControl::autoDataBindProperties(), TControl::bindProperty(), TControl::broadcastEvent(), TControl::bubbleEvent(), TControl::clearChildState(), TControl::clearControlState(), TControl::clearNamingContainer(), TControl::clearViewState(), TControl::convertUniqueIdToClientId(), TControl::createChildControls(), TControl::createControlCollection(), TControl::dataBind(), TControl::dataBindChildren(), TControl::dataBindProperties(), TControl::ensureChildControls(), TControl::findControl(), TControl::findControlsByID(), TControl::findControlsByType(), TControl::focus(), TControl::getAdapter(), TControl::getAllowChildControls(), TControl::getAttribute(), TControl::getAttributes(), TControl::getChildControlsCreated(), TControl::getClientID(), TControl::getControls(), TControl::getControlStage(), TControl::getControlState(), TControl::getCustomData(), TControl::getEnabled(), TControl::getEnableTheming(), TControl::getEnableViewState(), TControl::getHasAdapter(), TControl::getHasAttributes(), TControl::getHasChildInitialized(), TControl::getHasControls(), TControl::getHasInitialized(), TControl::getHasLoaded(), TControl::getHasLoadedPostData(), TControl::getHasPreRendered(), TControl::getID(), TControl::getNamingContainer(), TControl::getPage(), TControl::getParent(), TControl::getRegisteredObject(), TControl::getSkinID(), TControl::getSourceTemplateControl(), TControl::getTemplateControl(), TControl::getUniqueID(), TControl::getViewState(), TControl::getVisible(), TControl::hasAttribute(), TControl::initRecursive(), TControl::isDescendentOf(), TControl::isObjectRegistered(), TControl::loadRecursive(), TControl::loadState(), TControl::loadStateRecursive(), TControl::onDataBinding(), TControl::onInit(), TControl::onLoad(), TControl::onPreRender(), TControl::onUnload(), TControl::preRenderRecursive(), TControl::raiseBubbleEvent(), TControl::registerObject(), TControl::removeAttribute(), TControl::removedControl(), TControl::render(), TControl::renderChildren(), TControl::renderControl(), TControl::saveState(), TControl::saveStateRecursive(), TControl::setAdapter(), TControl::setAttribute(), TControl::setChildControlsCreated(), TControl::setControlStage(), TControl::setControlState(), TControl::setCustomData(), TControl::setEnabled(), TControl::setEnableTheming(), TControl::setEnableViewState(), TControl::setID(), TControl::setPage(), TControl::setSkinID(), TControl::setTemplateControl(), TControl::setViewState(), TControl::setVisible(), TControl::trackViewState(), TControl::traverseChildControls(), TControl::unbindProperty(), TControl::unloadRecursive(), TControl::unregisterObject(), TControl::__get()
|
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Method Details |
addAttributesToRender
protected void addAttributesToRender |
(THtmlWriter $writer ) |
Adds attributes to renderer.
Input |
THtmlWriter | $writer | the renderer |
Output |
Exception |
throws | TInvalidDataValueException if default button is not right. |
|
createStyle
Creates a style object to be used by the control.
This method overrides the parent impementation by creating a TPanelStyle object.
|
getBackImageUrl
public string getBackImageUrl |
() |
Output |
string
| the URL of the background image for the panel component. |
Exception |
|
getDefaultButton
public string getDefaultButton |
() |
Output |
string
| the ID path to the default button. Defaults to empty. |
Exception |
|
getDirection
public string getDirection |
() |
Output |
string
| alignment of the content in the panel. Defaults to 'NotSet'. |
Exception |
|
getGroupingText
public string getGroupingText |
() |
Output |
string
| the legend text when the panel is used as a fieldset. Defaults to empty. |
Exception |
|
getHorizontalAlign
public string getHorizontalAlign |
() |
Output |
string
| the horizontal alignment of the contents within the panel, defaults to 'NotSet'. |
Exception |
|
getScrollBars
public string getScrollBars |
() |
Output |
string
| the visibility and position of scroll bars in a panel control, defaults to None. |
Exception |
|
getTagName
protected string getTagName |
() |
Output |
string
| tag name of the panel |
Exception |
|
getWrap
public boolean getWrap |
() |
Output |
boolean
| whether the content wraps within the panel. Defaults to true. |
Exception |
|
renderBeginTag
Renders the openning tag for the control (including attributes)
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
renderEndTag
Renders the closing tag for the control
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
setBackImageUrl
public void setBackImageUrl |
(string $value ) |
Sets the URL of the background image for the panel component.
Input |
string | $value | the URL |
Output |
Exception |
|
setDefaultButton
public void setDefaultButton |
(string $value ) |
Specifies the default button for the panel.
The default button will be fired (clicked) whenever a user enters 'return' key within the panel. The button must be locatable via the function call TControl::findControl.
Input |
string | $value | the ID path to the default button. |
Output |
Exception |
|
setDirection
public void setDirection |
(string $value ) |
Input |
string | $value | alignment of the content in the panel. Valid values include 'NotSet', 'LeftToRight', 'RightToLeft'. |
Output |
Exception |
|
setGroupingText
public void setGroupingText |
(string $value ) |
Input |
string | $value | the legend text. If this value is not empty, the panel will be rendered as a fieldset. |
Output |
Exception |
|
setHorizontalAlign
public void setHorizontalAlign |
(string $value ) |
Sets the horizontal alignment of the contents within the panel.
Valid values include 'NotSet', 'Justify', 'Left', 'Right', 'Center'
Input |
string | $value | the horizontal alignment |
Output |
Exception |
|
setScrollBars
public void setScrollBars |
(string $value ) |
Input |
string | $value | the visibility and position of scroll bars in a panel control. Valid values include None, Auto, Both, Horizontal and Vertical. |
Output |
Exception |
|
setWrap
public void setWrap |
(boolean $value ) |
Sets the value indicating whether the content wraps within the panel.
Input |
boolean | $value | whether the content wraps within the panel. |
Output |
Exception |
|
|