Class TInlineFrame
TInlineFrame class
TInlineFrame displays an inline frame (iframe) on a Web page. The location of the frame content is specified by FrameUrl. The frame's alignment is specified by Align. The MarginWidth and MarginHeight properties define the number of pixels to use as the left/right margins and top/bottom margins, respectively, within the inline frame. The ScrollBars property specifies whether scrollbars are provided for the inline frame. And DescriptionUrl gives the URI of a long description of the frame's contents. Original Prado v2 IFrame Author Information
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 attribute name-value pairs to renderer.
|
TInlineFrameAlign
|
|
string
|
Returns the URL that this iframe will load content from This method is required by IDataRenderer.
|
string
|
|
string
|
|
integer
|
|
integer
|
|
TInlineFrameScrollBars
|
|
boolean
|
|
protected
string
|
|
void
|
|
void
|
Sets the URL that this iframe will load content from.
|
void
|
|
void
|
|
void
|
|
void
|
|
void
|
|
void
|
|
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 attribute name-value pairs to renderer.
This overrides the parent implementation with additional button specific attributes.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
getAlign
Output |
TInlineFrameAlign
| alignment of the iframe. Defaults to TInlineFrameAlign::NotSet. |
Exception |
|
getData
Returns the URL that this iframe will load content from This method is required by IDataRenderer.
It is the same as getFrameUrl().
Output |
string
| the URL that this iframe will load content from |
Exception |
|
getDescriptionUrl
public string getDescriptionUrl |
() |
Output |
string
| the URL to long description |
Exception |
|
getFrameUrl
public string getFrameUrl |
() |
Output |
string
| URL that this iframe will load content from. Defaults to ''. |
Exception |
|
getMarginHeight
public integer getMarginHeight |
() |
Output |
integer
| the amount of space, in pixels, that should be left between the frame's contents and the top and bottom margins. Defaults to -1, meaning not set. |
Exception |
|
getMarginWidth
public integer getMarginWidth |
() |
Output |
integer
| the amount of space, in pixels, that should be left between the frame's contents and the left and right margins. Defaults to -1, meaning not set. |
Exception |
|
getScrollBars
Output |
TInlineFrameScrollBars
| the visibility and position of scroll bars in an iframe. Defaults to TInlineFrameScrollBars::Auto. |
Exception |
|
getShowBorder
public boolean getShowBorder |
() |
Output |
boolean
| whether there should be a visual separator between the frames. Defaults to true. |
Exception |
|
getTagName
protected string getTagName |
() |
Output |
string
| tag name of the iframe. |
Exception |
|
setAlign
|
setData
public void setData |
(string $value ) |
Sets the URL that this iframe will load content from.
This method is required by IDataRenderer. It is the same as setFrameUrl().
Input |
string | $value | the URL that this iframe will load content from |
Output |
Exception |
|
setDescriptionUrl
public void setDescriptionUrl |
(string $value ) |
Input |
string | $value | the URL to the long description of the image. |
Output |
Exception |
|
setFrameUrl
public void setFrameUrl |
(string $value ) |
Input |
string | $value | URL that this iframe will load content from. |
Output |
Exception |
|
setMarginHeight
public void setMarginHeight |
(integer $value ) |
Input |
integer | $value | the amount of space, in pixels, that should be left between the frame's contents and the top and bottom margins. |
Output |
Exception |
|
setMarginWidth
public void setMarginWidth |
(integer $value ) |
Input |
integer | $value | the amount of space, in pixels, that should be left between the frame's contents and the left and right margins. |
Output |
Exception |
|
setScrollBars
|
setShowBorder
public void setShowBorder |
(boolean $value ) |
Input |
boolean | $value | whether there should be a visual separator between the frames. |
Output |
Exception |
|
|