Class wwWebControl
The wwWebControl class is the base controls for all other controls in the Web Connection WebControl framework. It provides the core functionality for most controls.
If you are a control developer you will want to take a close look at the control class to see how to override the base functionality of the Control Class.
Class Members
| Member | Description | |
|---|---|---|
|
AddAttribute | Adds an attribute to the Attributes collection with the optional ability to append to the existing attribute value if one exists by using the llAppend parameter.
o.wwWebControl.AddAttribute(lcKey,lcValue,llAppend)
|
|
|
AddScriptAttribute | Adds JavaScript code to an attribute based script event like onclick. This method allows appending script so that scripts are added cumulatively.
o.wwWebControl.AddScriptAttribute(lcScriptingEvent,lcScript,llAppend)
|
|
|
AddControl | This method is used to add any child controls to this control. AddControl provides the basic containership mechanism by setting the ParentControl property of the child control so it can reference…
o.AddControl(loCtl)
|
|
|
AddStyleTag | Adds or changes a style tag on the control's Style property. If you're chaning style properties in code it's recommended you use this method rather than directly changing the Style property…
o.AddStyleTag(lcStyle,lcValue)
|
|
BindControlSource | Internal method used to bind a ControlSource to the ControlProperty of the control.
o.BindControlSource()
|
|
|
DataBind | Performs databinding on a specific control. The base implementation is an abstract method so you need to provide an implementation for each control you create. Databinding comes in two flavors: *…
o.DataBind()
|
|
|
Dispose | Key method for clearing state of a control. It is crucial that every control calls Dispose() when shutting down, especially container controls. If Dispose() is not called it's very likely that there…
o.Dispose()
|
|
|
FindControl | Returns a control in the control's immediate child collection by name.
o.FindControl(lcControlId,llRecursive)
|
|
|
FireEvents | Generic WebControl method that is used retrieve the Event Target information and tries to find and fire the event specified. This method is relevant only for a container control and generally fired…
o.FireEvents(lcEventTarget)
|
|
|
GetCachedOutput | Internal method that retrieves the cached output by checking the cache. Returns "" if no cache hit is made. This method
o.GetCachedOutput()
|
|
|
HookupEvent | Attaches an event an event handler to a control event. For example, you use this method to wire an a button's Click event to your form's handler method that handles this event.
o.HookupEvent(lcEvent,loHandler,lcMethod)
|
|
|
LoadViewState | Internal implementation method that loads up control state from ViewState. Occurs prior to Post data processing. This method is responsible for de-parsing the controls viewstate and assigning…
o.LoadViewState()
|
|
|
OnInit | First event fired in the Page Pipeline. Called from the Init() of the control. This event always fires and you can use it to override any initiliazation behavior.
o.OnInit()
|
|
|
OnLoad | OnLoad fires once a control has been fully initialized. This means it has initialized and had its control state loaded either from ViewState or POST data. OnLoad() fires before any events are fired…
o.OnLoad()
|
|
|
OnLoadControlState | OnLoadControlState fires when the control tries to retrieve it's state in a POST back. The default implementation doesn't do anything - each control must implement its own functionality. This method…
o.OnLoadControlState()
|
|
|
OnLoadViewState | OnLoadViewState is called after Init and prior to reading POST data. This method retrieves any Viewstate data stored for this control and assigns it. The default implementation provides for most…
o.OnLoadViewState()
|
|
|
OnPreRender | Fires just before the Render() method and after Events have fired, so you can make any last minute changes to the page state before rendereing. OnPreRender() is very useful for code that need to run…
o.OnPreRender()
|
|
|
OnSaveViewState | Called after Render() has completed. This method by default handles picking up and encoding the ViewState. The final viewstate is collected by the Page class and encoded and written onto the form…
o.OnSaveViewState()
|
|
|
PreserveProperty | PreserveProperty is used to save property values between PostPacks using ViewState. This method lets you easily persist a control's property value in ViewState automatically. Note that the value…
o.PreserveProperty(lcProperty)
|
|
|
Process | Starts the Page Event Pipeline that starts firing the Event Sequence from OnInit through Dispose. This method should be called only on the the top level container to tell it to start processing page…
o.Process()
|
|
|
Render | The core method for each Web Control class that is responsible for creating the final HTML output for the control. The Render method should check for several things: * Visibility - if invisible just…
o.Render()
|
|
|
RenderControlError | This method is responsible for rendering Error icons/messages if an error occurs during unbinding.
o.RenderControlError()
|
|
|
ResolveUrl | Fixes up Urls based on an Application Relative path including support for ~ path syntax that injects the Application relative path into the URL. When parsing the path, the ~ value is replaced with…
o.ResolveUrl(lcUrl)
|
|
|
SaveViewState | Internal method that manages encoding ViewState for each control. Generally you don't need to override this method.
o.SaveViewState()
|
|
|
UnbindControlSource | Unbinds a Control Source from a Web Control back into the underlying Field. Works only for simple binding. This is the internal implemenation method
o.UnbindControlSource()
|
|
|
UnbindData | UnbindData retrieves data from a Control and binds it back into its ControlSource. This powerful method makes short work of retrieving data from controls back into their data stores. DataBind()…
o.UnbindData()
|
|
|
ValueOrExpression | Converts a value to a string and checks for expression syntax.
o.ValueOrExpression(lvValue)
|
|
|
WriteBaseTags | Writes out the basic tags used on a control. This method writes out most of the common tags specific to this control. This is the highlevel method that does most of the stock control tag output.…
o.WriteBaseTags(llSkipId, llNoWidthAndHeight)
|
|
|
WriteCachedOutput | Takes output and writes it into the cache. The framework takes care of naming the cachekey or uses the CacheKey you specified explicitly.
o.WriteCachedOutput(lcOutput)
|
|
|
WriteEnabledTags | Writes the Enabled and ReadOnly tags if they are set.
o.WriteEnabledTags()
|
|
|
WriteEncodedAttributeString | Writes an attribute value string that is properly encoded. The result value ensures that values like Text=" "Some Value" " don't occur but rather are translated into Text=" "Some Value" ".…
o.WriteEncodedAttributeString(lcValue)
|
|
|
WriteIdTags | Writes only the Name and ID tags.
o.WriteIdTags()
|
|
|
WriteStyleAndClassTags | Writes out the Style and Class tags for the control. The Style tag is written by using the existing value, and then parsing into it the height and width and color information. If these tags exist…
o.WriteStyleAndClassTags(llNoWidthAndHeight)
|
|
|
WriteUnitValue | Writes a measurement value as a string. If a numeric value is passed it's turned into a string with a px postfix for pixel size. String values are passed through and all others are transformed into a…
o.WriteUnitValue(vUnit)
|
|
Attributes | A collection of Attributes that are to be rendered on the control. Any attributed added is rendered into the HTML of the control. For example, to add a custom client side JavaScript script handler… |
|
|
AllowedMarkupChildren | A comma delimited list of element names that are allowed as child elements of this control and can be used without specifying runat="server" or the full wwWeb name. This property is used for… |
|
|
AutoPostBack | Determines whether controls automatically post back Note this property is not used by all controls. Some controls that support it: * TextBox * CheckBox * All List Controls |
|
|
BackColor | The Background Color for the control. |
|
|
BindingErrorMessage | An error message that is to be displayed when a bind back error occurs on the control. This property can be set for binding and validation errors and usually is set as part of ControlSource and… |
|
|
CacheDuration | If this value is > 0 the output of this control is cacheable. Value is in seconds. Cached content is stored using the wwCache object in Server.oCache. Be very careful with Cached content. Once… |
|
|
CacheKey | The optional name of the Cache key used if caching the output from the control. Optional - use only if you need to share the content with multiple controls on multiple forms otherwise the default… |
|
|
CanContainLiterals | Determines whether a control is a container control that can contain literal content. Some controls like Panel can while others like the WebDataGrid cannot. Internally used. |
|
|
ChildControls | Child Controls of the current control. Child Controls are vital to the Web Connection model as everything is based on containership. Parent Controls fire the events they receive into the… |
|
|
Context | A reference to the Web Connection Process class. Provided for ASP.NET conceptual compatibility. |
|
|
ControlIndex | |
|
|
ControlSource | A ControlSource expression that is evaluated during databinding and assigned to the control's ControSourceProperty. The Expression() must be valid for the context of the control. If you need to… |
|
|
ControlSourceFormat | FoxPro Format String applied when a control source is bound to data. Expressions can be stock FoxPro format strings or any FoxPro or custom function **FoxPro Format Expressions** You can use… |
|
|
ControlSourceMode | Determines how the ControlSource is applied for inbound and outbound binding. * **OneWay** - Binding occurs only on DataBind() * **TwoWay** - Binding occurs on both DataBind() and Unbind() *… |
|
|
ControlSourceProperty | The control's property that the ControlSource is binding to. For TextBox the ControlSource Property is Text. For a CheckBox it's Checked. For a ListBox it's SelectedValue. You can use this value… |
|
|
ControlSourceType | Optional property that allows explicit specification of the type of the control source. If omitted Web Connection uses TYPE() on the control source to determine the type, but this may not always… |
|
|
ControlSourceUnbindExpression | This optional property allows you to explicitly specify a separate ControlSource expression for unbinding back into the underlying data source. Use this if you need to bind to methods rather than… |
|
|
CssClass | A CSS class name applied to this control. |
|
|
DefaultEvent | The Default Event that is fired for a given control if no event argument can be found. |
|
|
DefaultProperty | Default property for a control that has embedded content. For example, a TextBox's content is mapped to the .Text property. Rick Rick is mapped to the Text property which is the DefaultProperty for… |
|
|
Enabled | Determines whether a control is enabled. PostBack controls that are disabled are automatically persisted into ViewState so their values are preserved. Similar behavior to ReadOnly. |
|
|
EnableViewState | Determines whether ViewState is enabled for this control. Generally you won't want to turn off Viewstate on controls. Unlike ASP.NET, Web Connection makes very sparing use of viewstate and does not… |
|
|
ErrorMessageLocation | Determines the location of Error Messages for controls when using control unbinding. Supported values are: 0 - None 1 - Icon to the right 2 - Icon and Text below 3 - Error Text only below |
|
|
ForeColor | ForeColor for this control if it applies. |
|
|
Height | The height of the control. This value is either numeric or string with string preferrable. |
|
|
ID | The ID/Name of the control. Note this value is used for collection access only. The Web page generated ID will always be the [UniqueId](vfps://Topic/_1MT037E0Y). |
|
|
IsContainerControl | Determines whether this control allows contained controls. Typical container controls are Panel, UserControl. Some not so common ones are DataGrid (contains columns), Repeater (contains Item… |
|
|
IsInputControl | Determines whether a control is used as an INPUT control and requires a NAME tag to be rendered. |
|
|
IsPostBack | Determines whether the current request is in a PostBack. Generally this property should be checked only on the form. |
|
|
lDisposeCalled | Internal flag that determines whether Dispose has been called on this control. Used to avoid duplicate Dispose calls. Any custom implementation of Dispose() should set this flag or have it set by… |
|
|
lEndResponse | Flag that is set to tell that the Response output has completed. No further rendering needs to take place. |
|
|
Page | Reference to the top level page object. This reference is used quite a bit internally so it's quite vital. The Page reference is passed in to the Init() of the control. Controls should check for… |
|
|
ParentControl | The immediate parent of the current control. The ParentControl property is set in the AddControl() method. |
|
|
OverrideNamingContainer | This property can be set on a container control to force it to NOT generate an additional naming container for its UniqueId property. This can avoid contained control names like panelContent_txtName… |
|
|
PostHtml | Html Text as a string the follows the control. |
|
|
PreHtml | Html text as a string that preceeds the control. |
|
|
PreservedProperties | A collection of properties of the control that are persisted into ViewState. By specifying a propertyname you are telling Web Connection to save the property value into viewstate and retrieve it… |
|
|
ReadOnly | Determines if a control is read only. The stock Postback controls (TextBox, ChkBox, Lists etc.) controls are automatically persisted into ViewState if the ReadOnly property is .T. |
|
|
RequiresFormRef | Internal property that determines whether the control requires a permanent form reference or whether it can be a local variable |
|
|
Style | A CSS Style string that is applied to the control. |
|
|
Text | The 'value' of the control. This is the primary value used for display and assignment. Note that Value mirrors the Text property, but it's more efficient to use Text. |
|
|
Tag | Generic string property that can be used to attach some state to a control. |
|
|
ToolTip | Sets the pop up tooltip for the control as set by title= on most controls |
|
|
UniqueID | A Unique ID for the control which is embedded into the page this value includes container and index information. Any retrieval of form variables should be done using UniqueID values. |
|
|
UserFieldName | The display fieldname for this control - optionallyused for error messages |
|
|
ValidationExpression | Validation Expression that validates the value that as been unbound by the Unbind() method by Control Source Binding. You can use any FoxPro expression that evaluates to .T. or .F. The expression… |
|
|
ViewState | ViewState is a collection of state values that are specific to a given control. Each control has its own ViewState and there's a 'global' viewstate on the Page object. ViewState is page based state… |
|
|
Visible | Determines if a control is visible. Invisible controls are not rendered at all! |
|
|
Width | Width for the control. This value can be a numeric or string value - string is preferred. This value is mirrored by the Protected cWidth property which can be more efficient. |
Comment or report problem with topic