It's the developer's responsibility to ensure the message text has been properly localized.
It's the developer's responsibility to ensure the message text has been properly localized.
It's the developer's responsibility to ensure the message text has been properly localized.
It's the developer's responsibility to ensure the message text has been properly localized.
A external reference has the form "//object_name/object_specific_part".
The control identified by object_name must implement
An internal reference is a reference within the same control that implements this instance of the interface. An internal reference can be absolute or relative. Absolute references must begin with the "/" character. Such references must be created relative to the root object in the control. Relative references are created relative to this reference.
Note that in complex reference models, multiple reference strings may point to the same underlying object. The reference string used to create the reference must be available to other methods such as ResolveReference, References and MarkRelativeIndicies. Consequently, if the reference string is relative, a proxy reference object should be returned that retains the relative reference string.
This method must be able to handle external, absolute and relative references as described in the CreateReference method.
Note that both references in the range must be local to each other.
The last element of the input reference replaces the last element of this reference.
This method is used by the evaluator to take an unscoped reference, such as a column reference, and merge into a fully scoped reference, such as a row reference, to yield a cell reference.
Note that this method must operate on the reference string used to create the reference. When a reference with relative scope is created by CreateReference, such as [Price(-1)], the underlying reference is a column reference. The reference string used to create the refernce is required to properly apply the scope to the merged result.
Returns a meaningful object context for the reference. This could be an UltraGridCell, UltraGridColumn, NamedReference, Control, etc.
An instance of this class may contain one of several base data types including doubles, singles, integers, booleans, strings, and error values.
The class implements the IConvertible interface providing methods to perform conversions between the basic data types. Additionally the class provides methods to perform basic arithmetic operations and comparisons betweenIf there is no meaningful conversion to an integer this method will throw an InvalidCastException
The instance value's underlying data type must be reference to return a reference, else an error reference is returned.
If there is no meaningful conversion to a reference, this method will throw an InvalidCastException
This method returns an
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
If there is no meaningful conversion, this method will throw an InvalidCastException
When using the 1900 date system in Excel, dates before 3/1/1900 must be corrected, because Excel incorrectly assumes 1900 is a leap year. This overload assumes the 1900 date system is being used as so it corrects the date values.
When using the 1900 date system in Excel, dates before 3/1/1900 must be corrected, because Excel incorrectly assumes 1900 is a leap year. This overload assumes the 1900 date system is being used as so it corrects the date values.
In Excel, only the fractional portion of the date value represents the time of day, so if
The TimeSpan.Days portion of the
Base reference associated with the formula. For example, in the case of a column formula, BaseReference would be the column reference.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly two operands/arguments.
Note: This operator must take exactly one operand/argument.
Note: This operator must take exactly one operand/argument.
Note: This operator must take exactly one operand/argument.
Returns an instance of IUltraCalcFormula. IUltraCalcFormula has information on any syntax or reference errors.
Returns an instance of IUltraCalcFormula. IUltraCalcFormula has information on any syntax or reference errors.
RemoveReference removes the specified reference from the calculation network. If the reference has a formula, the formula is also removed.
RemoveRowReference removes the specified reference from the calculation network. This method should be used when removing the reference for an item in a collection, such as an UltraGridRow. For other (non-collection) objects, use RemoveReference. If the reference has a formula, the formula is also removed.
AddReference adds the specified reference to the calculation network.
AddRowReference adds the specified reference to the calculation network. This method should be used when adding a reference for an item in a collection, such as an UltraGridRow. For other (non-collection) objects, use AddReference.
The context is the target object of the formula. It could be an UltraGridCell, a Control, a NamedReference, etc.
The error text to be displayed. The display of the error text will vary depending on the Context. A Control on a form will display the ErrorDisplayText as the tooltip to an ErrorProvider icon (if ErrorProviders are being used). A NamedReference will not display the ErrorDisplayText. A Grid cell will display the ErrorDisplayText in the cell, if possible.
If a Calculation or Reference Error occurs during a calculation, ErrorValue can be used to specify a default value to be used for display or saving. When an error occurs in a calculation, this value will be assigned to the appropriate property of the Context object. For example, in the case of a TextBox's Text property, the property itself will be set to the error value so that it both displays in the TextBox and is saved if the Text property is bound. In the case of an UltraGrid cell, this value will not be displayed, but will be saved to the underlying data source. Objects that do not display or bind, such as a NamedReference, will ignore the ErrorValue.
Provides detailed information about the error, such as the exact type of error.
The display of the icon varies depending on the context. A control on a form will show the icon as part of an ErrorProvider. NamedReferences show no icons. UltraWinGrid will not show the icon.
This is neccessary when the name of the control (and therefore the reference name) changes. The UltraCalcManager will automatically call this method at Design-time when the name of the control changes.
The Set implementation of this property must call AddParticipant on the IUltraCalcManager to add itself into the CalcManager's participants collection.
Also, the implementor should call RemoveParticipant when it is disposed.
This property should return a root reference whose CreateReference implementation can return a given child reference based on an absolute name.
Return true to tell the CalcManager not to extend the participant with an UltraCalcSettings property.
This method must be overridden by the Root reference object to deal with external or root references. The Root referece object must advance past the optional control name in a Fully Qualified Reference before calling RefLoop
Returns a meaningful object context for the reference. This could be an UltraGridCell, UltraGridColumn, NamedReference, Control, etc.
This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference
This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference
This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference
This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference
This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference
A Range returns a RefRangeCollection.
ResolveReference for a Range is from.ResolveReference
The ElementName for a Range is from.ElementName + ":" + to.ElementName
The Parent of a Range is this.from
A Range is always a Data Reference.
The AbsoluteName for a Range is from.AbsoluteName + ":" + to.AbsoluteName
The HasRelativeIndex for a Range is from.HasRelativeIndex
A Range returns a RefRangeCollection.
State = New York, City = New York
State = "New York", City = "New York"
State=New York,City=New York
A\/B = C\/D (column name is A/B and value is C/D.)
A = 10 miles\/hour, B = "20 miles/hour" (Withing double quotes only double quotes and backward slash have to be escaped.)
P1 = 10\, 20, P2 = "10, 20"
Returns an array of NameValuePair objects. Note: Names and values will be unescaped and also stripped of surrounding quotes.
State=New York where as example
of a standalone string value is New York. Standalone text values are used to
specify the scope in group-by rows. Example of a reference using standalone scope and a
name value pair scope is //ultraGrid1/Customers/State(NY)/Customers(CustomerID=ABCD).
If the scope was name-value pairs then sets the nameValuePairs to an array of parsed name-value
pairs. If the scope was a standalone text then sets the nonNameValuePairScope parameter.
If there was an error, returns an error string. If there was no error, returns null.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored always returns false.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored returns a reference constructed from merging the relative reference into the base reference.
RefUnAnchored returns the relative reference. When setting the relative reference, the merge reference is constructed by merging the relative reference into the base reference.
Returns a meaningful object context for the reference. This could be an UltraGridCell, UltraGridColumn, NamedReference, Control, etc.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored forwards this to the base reference.
RefUnAnchored uses the relative rp.
RefUnAnchored uses the relative rp.
RefUnAnchored returns the baseRef enumeration scoped to the merged reference.
RefUnAnchored forwards this to the base reference.
UCReference wraps an internal IUltraCalcReference class instance that points to the underlying object. That is, each method simply passes the IUltraCalcReference request to the underlying reference if the object is connected, else it returns, or throws, an appropriate error. UCReference has storage for the reference string and its underlying reference object.
There are two additional methods on UCReference: Connect and Disconnect. Connect will attempt to obtain a reference to the object it refers to given a base reference and it's reference string by calling the base reference's CreateReference method passing it the reference string. If its successful, it will store the newly created reference and use it to dispatch IUltraCalcReference requests against it. Disconnect will simply free the internal reference object after which its IUltraCalcReference methods will deal with a disconnected state. Virtually all references can be in a disconnected state at some point in their lifetime, therefore the CalcEngine uses UCReference instances to connect to all references. That is, the UltraCalcFormulaCompiler.Compile method creates UCRefernces for the all references in the formula string. The CalcEngine exposes a TopoChange event that objects used to notify it of topological changes. The TopoChange event passes a reference to the CalcEngine that describes the object that changed (e.g. column, row, grid, etc) along with a Create / Delete action argument. On Delete events, the CalcEngine will track down all formulas whose LHS is contained by the disconnected reference and delete them. This will clean up the recalc chain and ancestor map of any references including sub-references under the deleted reference. That is, column formulas will be deleted when the event's deleted reference is an entire grid, or cell references that are on the recalc chain when the deleted reference is a column. The ContainsReference on the reference passed with the TopoChange event determines whether the event affects a given reference. Secondly, all formulas who reference the deleted reference will be recalculated. On Create events, the CalcEngine will track down all references contained by the created reference and call the Connect method passing in the their formula's BaseReference. This will cause the CalcReference to reconnect to the underlying reference. Secondly, each re-connected reference's ancestor's will be recalculated.Returns a meaningful object context for the reference. This could be an UltraGridCell, UltraGridColumn, NamedReference, Control, etc.
Note: that property has no effect if the value of TextImageAlign property is set to ImageTop or ImageBottom.
Notes:
1. That property has no effect for button in normal state (WebButtonBase.Appearance.ContentShift).
2. If the Padding property of button in normal state is set in units others than pixels, then that property has no effect.
3. If the value of that property for button in pressed state is NotSet, then the value of DownRight for pressed button is used.
Notes:
1. If Url of image for button in normal state is not set, then image is not rendered for any state of button.
2. Width, Height and AlternateText properties have effect only for Appearance.Image (when button in normal state).
3. The Attributes property is not used for any state of button.
Notes:
1. The Width and Height properties are not supported.
2. The Cursor, Padding and Margin properties are supported only for button in normal state (WebButtonBase.Appearance).
3. When FileImages in RoundedCorners or UseBrowserDefaults are enabled, then background and border related properties may have no effect.
4. Only following attributes in CustomRules are supported: filter, letter-spacing and writing-mode.
Note: When FileImages in RoundedCorners or UseBrowserDefaults are enabled, then that property may have no effect.
Because of the stateless nature of web connections, and the typical delays involved in returning information from the server, WebMenu implements both client-side events and server-side events. You can choose whether you would like to respond to client-side events, which must be implemented through JavaScript.
The ButtonClientSideEvents object maintains a list of event handlers that are implemented on the client and called in response to events as they occur in the browser. Each event is a string that represents JavaScript function name. The named function must be implemented by the developer in JavaScript code.It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 1 parameter.
1st parameter contains reference to the WebButtonBase object
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object
2nd parameter contains reference to the ig_EventObject object
That event can be canceled by oEvent.cancel=true;
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object.
2nd parameter contains reference to the ig_EventObject object.
That event can be used to customize appearance of button.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object
2nd parameter contains reference to the ig_EventObject object
This event can be canceled.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object
2nd parameter contains reference to the ig_EventObject object
This event can be canceled.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object
2nd parameter contains reference to the ig_EventObject object
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object
2nd parameter contains reference to the ig_EventObject object
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object.
2nd parameter contains reference to the ig_EventObject object.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object.
2nd parameter contains reference to the ig_EventObject object.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object.
2nd parameter contains reference to the ig_EventObject object.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object.
2nd parameter contains reference to the ig_EventObject object.
It can be the name of implemented function or explicit javascript statement(s). If the name of function is used, then that event handler may contain 2 parameters.
1st parameter contains reference to the WebButtonBase object.
2nd parameter contains reference to the ig_EventObject object.
Some objects do not have values that can be converted to a string. In these cases, an empty string is returned.
Invoke this method to reset all properties of this controls
The string specified for ImageDirectory will be prefixed onto the image related properties.
Note that if a particular image's file name starts with a ".", "/" or "\\" character, or contains the ":" character, then that filename will be used as it is without the ImageDirectory prefix.
Permitted values are DownLevel, UpLevel, and Auto. The default value for this property is Auto which will detect the client browser and renders the output deemed appropriate for that browser.
Default value is true.
Note: If any appearance related property is set, then those values are not affected and they have priority over corresponding "automatic" defaults.
At the time the WebButtonBase supports only 3 types of predifined styles:
If value is set to false, then only mouse click will trigger action event.
Note: To create underline appearance,- the first character in the text which matches with the AccessKey is rendered with the <u> tags.
Note: If Inline is enabled, then some browsers may fail to render button or ignore Width and Height of control when percent units are used.
Every member property can contain the name of implemented function or explicit javascript statement(s). If the name of a function (only name: no parenthesis or parameters) is used, then actual implementation on client may contain parameters: please see documentation for Client-Side Object Model.
Note: When button has focus and mouse is moved over it, then FocusAppearance is merged with HoverAppearance. In case of conflicts, the properties of HoverAppearance has priority over FocusAppearance.
Note: When button has focus and mouse is moved over it, then FocusAppearance is merged with HoverAppearance. In case of conflicts, the properties of HoverAppearance has priority over FocusAppearance.
Use this property to change the name of the external JavaScript file.
Note The JavaScript file specified by this property must be the one that is included with the product, or an equivalent customized file that implements the identical functionality.
Use this property to change the name of the common external JavaScript file.
Note If your application uses any other instance of any Infragistics Web control, then values of this property in all controls should match. Otherwise, client-side functionality in all controls may fail.
The string specified for ImageDirectory will be prefixed onto the image related properties.
Note that if a particular image's file name starts with a ".", "/" or "\\" character, or contains the ":" character, then that filename will be used as it is without the ImageDirectory prefix.
That can be used to pass any javascript data to client.
This method is called in an endless loop with incremented values of the index parameter, until the Control returns null.
The rendered html and returned string are passed back to the doResponse javascript function implemented by the Control on the client as pairs of elements in an array.
For example, if the Control will write "hello" at (index==0) and return "first", write "privet" at (index==1) and return "second", and return null at (index==2), then the doResponse on the client will have the following array of strings: ["first","hello","second","privet"]
If control like UltraWebTab implements GetNumberOfHtmls, then at index -1 it should return its eval expression.
The WebAsyncRefreshPanel at index 0 returns its UniqueID. For other values of the index it returns values from linked renderers or flags for external WebControls. The WebTextEdit returns the eval-expression similar to igedit_getById(UniqueID). The UltraWebTab implements GetNumberOfHtmls. At index -1 it returns the eval-expression similar to igtab_getTabById(UniqueID), for all other indexes it returns IndexOfTab.
The rendered html and returned string are passed back to the doResponse javascript function implemented by Control on client as pairs of elements in array.
If id of html element is different from UniqueID, then CallBackManager attempts to find html element which id is based on UniqueID: replacing the ":" character by the "_" character, appending "_hidden", etc.
If id of html element is different from UniqueID, then CallBackManager attempts to find html element which id is based on UniqueID: replacing the ":" character by the "_" character, appending "_hidden", etc.
The default implementation of this method
nulls out the
Inheritors overriding this method should always call this base implementation to assure the object has only one distinct primary collection.
The default implementation sets the
Inheritors overriding this method should always call this base implementation to assure the object has only one distinct primary collection.
A
Customarily, the base class implementations of the
A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to an HTML hidden input element when subsequent requests are processed. For more information about saving server control view state, see Maintaining State in a Control.
This filter is only intended to support designer rendering and implementations of the IProvideDesignTimeHtml interface, particularly by composite controls.
This constructor is public so that this class can be instantiated from controls residing in an external assembly. Your Web application should not call this constructor directly.
This constructor is public so that this class can be instantiated from controls residing in an external assembly. Your Web application should not call this constructor directly.
The CssToInlineStyleReader class only overrides this method. Consumers wishing to filter their markup stream must repeatedly call this method until it returns null (Nothing in Visual Basic .NET).
Infragistics ASP.NET controls implement this interface to interoperate with the Application Styling Framework(tm) (ASF) that provides application developers and graphic designers an easy way of collaborating to bring a consistent appearance to the user interface elements of their Web applications.
This interface features a single defaultable boolean
The consistent appearance is defined by a set of cascading
style sheets (CSS) files, and graphic images, created by graphic designers.
The collection of these files are referred to as a style set. The
Controls participating in ASF must initialize their Style
objects when the framework calls their control back by implementing the
Application styles rendered at design-time must be loaded
from the external style sheet (*.css) files, otherwise the control may not
appear properly styled within the Integrated Development Environment (IDE).
The
The
The Application Styling Framework(tm) (ASF) calls this method on controls to notify them of a change in one or more Application Styling properties affecting their appearance. This is an opportunity for the control to invalidate any data it may have cached based on the arguments it receives in this notice.
For example, ASF may call this method to notify a control of a modification having been made to the "web.config" configuration file, or in the style definitions of the Cascading Style Sheet (CSS) file for this control and style set.
This property applies at design-time only.
The resolution process for image URLs takes into account
the
Turn on support for Application Styling of this control when using the Application Styling Framework(tm) (ASF) by setting the EnableAppStyling property to True.
When EnableAppStyling has it's default value of NotSet, this control will defer the determination of whether to use Application Styling to settings you make at the page- or application-level. Place the WebPage control on the same Web form as this control to configure ASF support for all controls on that Page. ASF support can also be turned on application-wide with the enableAppStyling attribute in your "web.config" file.
Turn off support for ASF in this control (even though it may have been enabled at a higher level) by setting the EnableAppStyling property to False.
The name of the Application Styling Framework(tm) (ASF) style set which has been designed to give this control a consistent appearance with other controls in your application.
This property may return the empty string ("") to imply that the default style set (named "Default") should be used.
Web sites can configure a single, consistent, application-wide style set through the styleSetName attribute in their "web.config" file. Alternately, they can define the style set to apply Application Styling to all controls on a Page by placing a WebPage control on that Page and setting it's StyleSetName property.
At the control level this property allows an application developer to customize the style set applied to a single instance of a control.
Normally, graphics designers will furnish you with a style set containing one or more style sheet files (one for each type of control) and image files. The name of the style set (with the exception of the "Default" style set) must appear in each Cascading Style Sheet (CSS) class name defined by this control's style sheet file. For example, two WebTree controls that each use a different style set, "Aqua" and "Onyx", would expect their CSS class names for the ASF Node role to be "igtr_AquaNode" and "igtr_OnyxNode", respectively. This allows the uniqueness of CSS class names necessary to distinguish multiple style sets for the same type of control, without there being any naming collisions.
Changing the style set name should invalidate any style definitions being cached by
Web sites can configure the directory path containing their style set files application-wide by using the styleSetPath attribute of their "web.config" file. It is also possible to configure the style set path applicable to all controls on a Page that are subject to Application Styling by placing a WebPage control on that Page and setting it's StyleSetPath property.
At the control level this property allows an application developer to customize the location of the style set being applied to a single instance of a control.
Changing the style set path should invalidate any style definitions being cached by
Be aware that customizing the style set path at the control level will not allow you to copy a style set's files to this new location, changing a few style property values in them, and then use it successfully with separate instances of the control referencing the original style set of the same name. This is because there would be naming collisions in the Cascading Style Sheet (CSS) class names, which will produce an undefined appearance. You must ensure the CSS class names defined by style sheets in the new style set path are unique from those CSS class names being used by other style sheets that may continue to be referenced. The recommended guidance in this scenario is to create a new style set having a new style set name, that contains your modifications.
The property always provides the path the control is using, regardless of whether that path was set at the application-, page- or control-levels.
The set method (mutator) of this property is included only for backwards compatibility. Application Styling Framework(tm) (ASF) does not recognize changes made to this property.
A non-default style sheet filename may
be specified if it is done in a fully-qualified
May be thrown by implementations that do not support setting this property.
Implementations are allowed to ignore assignments to this property without throwing an exception.
The CSS class names that define the style information for each Application Styling Framework(tm) (ASF) role are made unique by Type of control because every control provides a unique StylePrefix string.
For example, the UltraWebToolbar control specifies it's prefix as "igtb" therefore all CSS class names appearing in the CSS style sheet of it's style sets must start with "igtb_". This allows Application Styling to work on toolbars appearing on the same Web forms with other types of controls (like grids) without CSS class naming collisions for common ASF roles (like the Item role.)
Normally this location will default to
the directory containing the style sheet file for the
current style set. If assigned independently, the
Cascading Style Sheets (CSS) mandate image URLs appearing as an url() must be inside or beneath the site and directory from which the CSS file was loaded. The browser resolves these url() values in accordance with the CSS specification requirements when it requests the images from the server. This means certain CSS style properties like background-image may not resolve according to your ImageDirectory setting.
The integrated development environment (IDE) does not resolve styles for using Cascading Style Sheet (CSS) files which are linked external from the Web form. Application Styling can only be seen fully at design-time when the control manages for itself the style definitions contained by the style set's CSS style sheet files.
The Application Styling Framework(tm) (ASF) provides the
When a control supporting Application Styling renders at design-time, it must replace the CSS class names that appear in it's design-time markup with their corresponding inline HTML style attributes.
This property applies at design-time only.
This constructor is provided for subclasses to invoke the
base class type initialization; instances of
Accessing AllEventsEnabled returns True if and only
if all events are enabled. Assigning a value to AllEventsEnabled allows
the developer using the
This constructor should be used in order to resolve the URL specified to the proper path.
This constructor should be used in order to resolve the URL specified to the proper path.
This constructor should be used in order to resolve the URL specified to the proper path, while ensuring the resulting <img> tag is accessible according to Section 508 requirements.
Called by the
Inheritors must call the base class implementation of this method before restoring their own default values.
This method supports the internal Infragistics control infrastructure and is not intended for use from applications.
The control or form using this Image
object should set this property to it's own accessibility settings
before rendering. The control or form remains responsible for setting
the
This property corresponds to the "alt" attribute of an HTML <img> element.
Some browsers may display this text in the form of a tool tip.
Assistive technology used to enable accessibility to Web-based content, such as screen readers, may make use of this text as a description equivalent to the original image. Avoid assigning alternate text to transparent spacer images, or images whose purpose is solely decorative.
This value should be a relative path following HTML and IETF standards for a relative Uniform Resource Locator (URL). You may specify "~/" in the beginning of the URL, to specify that the image should be based off of your Application root. The URL specified here will use an ImageDirectory specified in your "web.config" file, if present.
A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to an HTML hidden input element when subsequent requests are processed. For more information about saving server control view state, see Maintaining State in a Control.
This constructor should be used in order to resolve the URL specified to the proper path.
This constructor should be used in order to resolve the URL specified to the proper path.
This constructor should be used in order to resolve the URL specified to the proper path, while ensuring the resulting <img> tag is accessible according to Section 508 requirements.
If this is not specified, the image will be drawn according to it's native height. If the height here differs from the native image height, the image will be stretched (or shrunk) to fit.
Stretching (or shrinking) may lead to distortion of the image. It is the application's responsibility to not specify image heights disruptive to the control or form layout.
If this is not specified, the image will be drawn according to it's native width. If the width here differs from the native image width, the image will be stretched (or shrunk) to fit.
Stretching (or shrinking) may lead to distortion of the image. It is the application's responsibility to not specify image widths disruptive to the control or form layout.
Use the Attributes.CssStyle property, to specify CSS (Cascading Style Sheet) style properties for this Image object. Use this collection to specify attributes like "border", "onclick", etc., as permitted on an <img> element by the W3C (X)HTML DOCTYPE used by your Web form.
Background images do not have alternate text, therefore the AlternateText property is not applicable when rendering a background image.
You must call Render on the SimpleBackgroundImage before you write any tags for the element that is to contain the background image, because the HtmlTextWriter applies all accumulated attributes to the element tag at the time you call RenderBeginTag on it.
Background images never use alternate text and must not be used to confer
information you wish to be accessible to all audiences. The/
This value should be a relative path following HTML and IETF standards for a relative Uniform Resource Locator (URL). You may specify "~/" in the beginning of the URL, to specify that the image should be based off of your Application root. The URL specified here will use an ImageDirectory specified in your "web.config" file, if present.
The default implementation of this method
nulls out the
Inheritors overriding this method should always call this base implementation to assure the object has only one distinct primary collection.
The default implementation sets the
Inheritors overriding this method should always call this base implementation to assure the object has only one distinct primary collection.
Developers should assign key names that are
unique to the collection an object is stored within, when it
is necessary to retrieve the object directly using the collection's
A
Customarily, the base class implementations of the
Developers should assign key names that are
unique to the collection an object is stored within, when it
is necessary to retrieve the object directly using the collection's
A
Customarily, the base class implementations of the
Non-visual Infragistics Web elements use this
implementation of the
In CLR 2.x, logoImageUrl should be loaded from an embedded resource in the non-visual control's assembly.
PrimitiveTypeDefault is a ValueType to avoid the overhead associated with instantiating a new instance of a class.
Two
An empty date will be treated as the smallest possible date based on DateTime.MinValue.
An empty date will be treated as the smallest possible date based on DateTime.MinValue.
Provided for compatibility with DateTime. By default,
Provided for compatibility with DateTime. By default,
An empty string is assumed to represent an empty date. An empty date is returned as the smallest possible date (DateTime.MinValue).
The date value is considered empty when it is the smallest possible date (DateTime.MinValue). If the date is empty, this method returns an empty string. Otherwise it returns the date value formatted based on the formatString parameter.
This method works the same as the CompareTo method on the DateTime structure, with the difference that it understands the concept of empty date values as implemented by SmartDate.
Only supported when value is also of type SmartDate.
This field represents the empty value of the SmartDate
if
This field represents the empty value of the SmartDate
if
Provided for compatibility purposes with existing DateTime
application code. The preferred solution is to use the
When the SmartDate is empty this method returns the empty string for compatibility with the approach described above.
The format string should follow the requirements for standard .NET string formatting statements.
This property can be used to set the date value by passing a text representation of the date. Any text date representation that can be parsed by the .NET runtime is valid.
When the date value is retrieved via this property, the text
is formatted by using the format specified by the
If the SmartDate contains an empty date, this returns DBNull. Otherwise the actual date value is returned as type DateTime.
This property is very useful when setting parameter values for an ADO.NET Command object, since it automatically stores null values into the database for empty date values.
A clock tick is a time-interval of 100-nanoseconds.
When
Intercepts calls made to HtmlTextWriter for filtering and diagnostic purposes.
Web elements extending
The SmartWebControl serves as a base class for advanced web elements that require view state, licensing, rendering and postback management. This functionality is built into this base class and requires no additional coding beyond conformance to a set of simple practices.
Features supported by SmartWebControl:
Set to a common name if more than one control needs to register the same javascript file. Otherwise, leave empty.
Inheritors should override the
This identifier is used to name client-side event handlers at design-time.
The client-side events property subobject is a compound
object with one property per client-side event that can have an event
handler specified for it at design-time. See the
This method supports the design-time serialization of ASP.NET pages. Inheritors should not need to call this method directly. If a subclass overrides JavaScriptFileName to alter it's default value, then it should override ShouldSerializeJavaScriptFileName with it's own implementation.
This method is made available only so that the design-time environment can display a Reset option on the context menu within the Properties Editor. It is not intended for use by application developers.
Inheritors overriding this method to reset the
Some of the content that the SmartWebControl implementation of OnPreRender takes care of are the registering of <script> blocks, the initialization of global objects and property arrays within Javascript, and the emission of a <style> block defining common CSS styles when required.
Inheritors may override this method to handle the PreRender event internally (without adding an event handler) and/or provide additional processing before rendering starts. An override must call the base method. Failure to call the base method will lead to subscribers of the PreRender event not receiving notification that the event has fired, and possible failure to emit necessary <script> and <style> blocks leading to script errors and an absence of expected styling, respectively.
If a
Inheriting controls must implement this factory method to
associate their own custom
The CreateRenderer method will be invoked by the
base SmartWebControl class when it first calls
Inheritors overriding the Render method must call the base
class implementation of it in order for the SmartWebControl to properly
dispatch the chore of rendering content to the SmartRenderer created by
the subclass' override of
Containers that aggregate the SmartWebControl as one of their child elements may use interception to filter the HTML content produced by the SmartRenderer. This involves substituting a second HtmlTextWriter that drains into a StringWriter for the one supplied by the ASP.NET Framework. After rendering of its child elements is complete, the container may serialize the StringWriter and perform post-render text processing, substitution and replacement on the resulting text before forwarding it to the original HtmlTextWriter from the ASP.NET Framework.
Interception incurs overhead when it creates the intermediate string representation, and therefore may not be an applicable technique in web solutions where large amounts of content are rendered.
When multiple reference Types are stored in the ViewState of a SmartWebControl it may be necessary to typecast the argument passed in for the def parameter.
For comparison purposes, the sub-object continues to possess the old value until after the change notifications have completed.
For comparison purposes, the sub-object continues to possess the old value until after the change notifications have completed.
This method initializes the Style object to take on the default appearance specified by a CSS class in an external stylesheet. CSS classes in an external stylesheet maintain a consistent naming convention by which their names are well-known, and can be connected to the appropriate Style properties at init-time by this method.
Name collisions are avoided because InitializeStyle
will read the
Inheritors should call this method immediately after lazily creating an empty Style object reference, but before tracking viewstate on it, for any Style properties added by their subclass. Failure to call this method when initializing a Style property will cause the Style not to appear as if based upon the style rules in the external stylesheet. A subclass may assume responsibility for performing their own Style property initializations at this recommended point in time after lazy creation and before tracking viewstate, but should not expect the Style property to function correctly with the default external stylesheet.
The CssClass can be set to work with other external or embedded CSS classes, of course.
Clears all viewstate values so that calls to the
property accessors yield the default argument passed-in, and
cascades a call to
Inheritors overriding this method should call the base class' implementation to ensure these expected behaviors take place.
This method is a public to implement the IPostBackEventHandler interface. External (or parent) elements may percolate event notifications down to this element by invoking this method with a suitably formatted eventArgument.
Inheritors may carry out further processing
of the eventArgument by overriding
The formatting of the eventArgument is subject to change.
Inheritors perform processing of post back
events by overriding this method to parse the eventArgument
and direct the reaction of their element. This method is called
indirectly by the ASP.NET framework through the IPostBackEventHandler
interface, which
Inheritors must not make any assumptions about the timing in which they receive a particular event notification during post back, and the notifications of any and all other events.
The formatting of the eventArgument is subject to change.
Posted back data generally appears url-encoded within the body
of an HTTP post. The ASP.NET framework unpacks this information and dispatches
it to elements on the page which implement IPostBackDataHandler, such as
the
The client-side object model generally posts back information related to state changes and actions undertaken by the end user with the element. This method is how the client-side and server-side communicate this stateful information back and forth.
Inheritors wishing to process posted back data added by their
SmartWebControl subclass' client-side object model should override the
The base class implementation of OnLoadPostData parses the XML content within posted back data.
Inheritors may override the base class implementation of OnLoadPostData to obtain access to posted back information pertaining to their SmartWebControl subclass. However, the first statement in the overridden method implementation should be to call the base class' implementation of OnLoadPostData.
The base class implementation of
Inheritors maintaining this structure of control state are encouraged to override this method in order to read changes in sub-property values to client-side objects having analogous server-side correspondents.
Inheritors can override this method to perform pre- or postprocessing
of these events, as long as they invoke
Those events that will be processed were collected during the
handling of
Inheritors may override this method to process the list of event Pairs or Triplets that require the firing of server-side events for their application.
Inheritors implement an override of this method in their subclasses to instatiate property subobjects (compound properties) based on a supplied typeID. The typeID that is received will be the same identifier as the subclass uses to store and retrieve the subobject from the ViewState. This method is called during LoadViewState when rehydrating the Page.
Inheritors are strong advised against overriding the base
class' implementation of LoadViewState, as doing so will likely
disrupt normal functionality of the
Inheritors are strong advised against overriding the base
class' implementation of SaveViewState, as doing so will likely
disrupt normal functionality of the
Calling this method informs the ASP.NET WebControl to track
it's viewstate, and dispatches to all property subobjects that implement IStateManager
to do the same. All subobjects derived from
Inheritors do not need to override the base class implementation
of TrackViewState as long as they create and store their property subobjects
in the
This method supports the design-time serialization of ASP.NET pages.
Inheritors overriding
The name of the Application Styling Framework(tm) (ASF) style set which has been designed to give this control a consistent appearance with other controls in your application.
This property may return the empty string ("") to imply that the default style set (named "Default") should be used.
Web sites can configure a single, consistent, application-wide style set through the styleSetName attribute in their "web.config" file. Alternately, they can define the style set to apply Application Styling to all controls on a Page by placing a WebPage control on that Page and setting it's StyleSetName property.
At the control level this property allows an application developer to customize the style set applied to a single instance of a control.
Normally, graphics designers will furnish you with a style set containing one or more style sheet files (one for each type of control) and image files. The name of the style set (with the exception of the "Default" style set) must appear in each Cascading Style Sheet (CSS) class name defined by this control's style sheet file. For example, two WebTree controls that each use a different style set, "Aqua" and "Onyx", would expect their CSS class names for the ASF Node role to be "igtr_AquaNode" and "igtr_OnyxNode", respectively. This allows the uniqueness of CSS class names necessary to distinguish multiple style sets for the same type of control, without there being any naming collisions.
Turn on support for Application Styling of this control when using the Application Styling Framework(tm) (ASF) by setting the EnableAppStyling property to True.
When EnableAppStyling has it's default value of NotSet, this control will defer the determination of whether to use Application Styling to settings you make at the page- or application-level. Place the WebPage control on the same Web form as this control to configure ASF support for all controls on that Page. ASF support can also be turned on application-wide with the enableAppStyling attribute in your "web.config" file.
Turn off support for the ASF in this control (even though it may have been enabled at a higher level) by setting the EnableAppStyling property to False.
Web sites can configure the directory path containing their style set files application-wide by using the styleSetPath attribute of their "web.config" file. It is also possible to configure the style set path applicable to all controls on a Page that are subject to Application Styling by placing a WebPage control on that Page and setting it's StyleSetPath property.
At the control level this property allows an application developer to customize the location of the style set being applied to a single instance of a control.
Be aware that customizing the style set path at the control level will not allow you to copy a style set's files to this new location, changing a few style property values in them, and then use it successfully with separate instances of the control referencing the original style set of the same name. This is because there would be naming collisions in the Cascading Style Sheet (CSS) class names, which will produce an undefined appearance. You must ensure the CSS class names defined by style sheets in the new style set path are unique from those CSS class names being used by other style sheets that may continue to be referenced. The recommended guidance in this scenario is to create a new style set having a new style set name, that contains your modifications.
Specifies the location where one or more Javascript files that support the client-side functionality of this element are stored. The SmartWebControl base class handles registering a <script> block on the page with the ASP.NET framework to retrieve the identified Javascript file at run-time.
Inheritors providing support for multiple Javascript files (which should conventionally share the value specified by this property as their common root stem) are required to handle registering <script> include blocks for these additional files on their own.
Failure to specify the correct location of an element's Javascript files can cause the element to generate random Javascript errors in the browser at run-time. Please ensure the specified location is reachable, and contains a consistent version of the necessary Javascript files that are compatible with the current element's assembly. For example, if your application has recently deployed updated versions of the Infragistics assemblies, then ensure that the location specified by the JavaScriptFileName property contains a compatible set of Javascript files.
Inheritors may override this property to specify a different default value.
Specifies the location where the common client-side infrastructure Javascript file is installed. The SmartWebControl base class handles registering a <script> block on the page with the ASP.NET framework to retrieve the identified Javascript file at run-time.
The location specified by this property should be consistent with the location specified for the common Javascript files of other elements on the page, because the <script> include for this property will be generated only once for all of the Infragistics elements contained on the page.
Failure to specify the correct location of the common Infragistics Javascript files can cause elements to generate random Javascript errors in the browser at run-time. Please ensure that the common Infragistics Javascript files that have been installed are of a consistent version and build number with the element's Javascript files installed at the location specified by JavaScriptFileName.
Inheritors may override this property to specify a different default value.
This property specifies the location of an external Cascading Style
Sheet (CSS) resource for the current SmartWebControl to use. This style sheet
should contain definitions of well-known style names starting with
If unspecified, the default CSS resource will be used for the element's default styles. If that resource cannot be found, the element will be displayed with a blank appearance and minimal style information to achieve normal layout and behavior.
This prefix will be rendered in front of CSS classes and other identifying labels to ensure their uniqueness for a given type of control. The timing when this prefix gets applied may be prior to the Init event firing, therefore it should not be used for differentiating control instances.
Inheritors should override this property and provide a short non-null string uniquely identifying the Type of their control. Failure to override ControlPrefix may cause some CSS class name collisions between different types of controls. For example, when a WebMonthView and a WebDayView are on the same page, a name conflict is possible between their DayStyle CSS classes (whose default CSS class name could be Day) unless they override ControlPrefix. If WebMonthView returned the prefix, "month", from its override then it's DayStyle would render with the CSS class name monthDay and no longer be in conflict with other controls on the page with a different type.
GetOwnerData and
Support for the cursor style varies from browser to browser. Browsers may substitute a more basic cursor for one a web application recommends, for instance, if such a mouse pointer isn't supported by the client's operating system.
If this property returns True, there are no formatting attributes set for the style object, or all of its properties have been reset to their default values.
A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to an HTML hidden input element when subsequent requests are processed. For more information about saving server control view state, see Maintaining State in a Control.
True if the BorderDetails object from which this method was invoked has any useful data; otherwise, False.
Invoke this method to reset all properties of the BorderDetails class to their default values.
The "ShouldSerialize" properties of the BorderDetails will retun False until set again.
Use the CopyFrom method to duplicate the BorderDetails object properties into the instance of the BorderDetails class from which this method is invoked.
All properties in the current instance of the BorderDetails class will be replaced by their corresponding properties in the BorderDetails specified by the source parameter.
A BorderDetails object that represents the instance to copy.
A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to an HTML hidden input element when subsequent requests are processed. For more information about saving server control view state, see Maintaining State in a Control.
Some objects do not have values that can be converted to a string. In these cases, an empty string is returned.
Invoke this method to reset all properties of the Style class to their default values.
The "ShouldSerialize" properties of the Style will return False until set again.
The filename of an image to be displayed in the background of an object.
Use this property to specify additional CSS style rules to render to an element on the client.
Styles specified through this property are comprised of name: value; pairs, where the name of a CSS style property is separated from its value by a colon assignment operator, and each assignment is terminated by a semicolon. Failure to properly format these assignments may lead to undefined behavior, such as CSS conformant browsers ignoring one (or all) style rules for the affected element.
Use this property to specify the cursor to use for the object on the client. It will be rendered as the CSS cursor attribute.
The amount of space for margins of an object.
Margins can be set for the entire object or for one or more of its sides.
Use this property to specify the margins to render the object with on the client. It will be rendered as the CSS margin attribute.
The amount of space to insert between an object and its edges.
Padding can be set for the entire object or for one or more of its sides.
Use this property to specify the padding to render the object with on the client. It will be rendered as the CSS padding attribute.
The details of the style's border such as individual color, style and width of each side of it.
Use this property to specify different colors and widths for each side of the border. You can also use standard BorderColor and BorderWidth properties but they will be overriden on the side you set in the border details. It will be rendered as the CSS border attributes.
An instance of the WebAgent object will be created inside
of controls that support Application Styling. It facilitates a control's
implementation of the
If both roleName and baseRoleName are nulls (or empty strings) or EnableAppStylingResolved is false, then internalClassDefault is reset, but style is added to CssBuilder according to priority.
If priority is negative, then style is not added to CssBuilder.
When EnableAppStyling = True this method will copy output from the buffered HTML writer into a real one. This method validates whether rendering occurs in design mode so that it has no effect at run-time. To support Application Styling your control should call this method at the end of your Render method.
This property resolves the EnableAppStyling
value at the control-, page- and application-levels to identify whether the
associated
If the current StyleSetName is "Default", this method returns the empty string so that CSS class names can be resolved correctly. Only non-default style sets interject their name before the role in the CSS class names generated by the Application Styling Framework(tm).
Some objects do not have values that can be converted to a string. In these cases, an empty string is returned.
Invoke this method to reset all properties of the ClientSideEvents class to their default values.
The "ShouldSerialize" properties of the ClientSideEvents will return False until set again.
A server control's view state is the accumulation of all its property values. In order to preserve these values across HTTP requests, ASP.NET server controls use this property, which is an instance of the StateBag class, to store the property values. The values are then passed as a variable to an HTML hidden input element when subsequent requests are processed. For more information about saving server control view state, see Maintaining State in a Control.
A
Customarily, the base class implementations of the
Used to detect concurrency violations when a stale object is used by an add or update operation. Not intended to be accessed directly by the application.