The TitleBox component implements container for express report title.
The TitleBox component is implemented by the TitleBox class.
The TitleBox component may look as follows:
The example of creating the TitleBox component is given on the Example of Creating the EaxTitleMaster Component page.
Constructor name | Brief description | |
TitleBox | The TitleBox constructor creates an instance of the TitleBox component. |
Property name | Brief description | |
DimTreeMode | The DimTreeMode property determines a data view that will use the title. | |
EditMode | The EditMode property sets value of the Edit Mode checkbox for the express report title. | |
EnableEdit | The EnableEdit property determines whether express report title can be edited. | |
Instance | The Instance property returns express report title. | |
IsMultiLanguage | The IsMultiLanguage property determines whether title translation button is displayed when the title is edited. | |
NeedValidate | The NeedValidate property determines whether the title needs to be validated. | |
Options | The Options property sets and returns settings of the express report title. | |
Service | The Service property determines an object of service for working with title. | |
Source | The Source property sets a data source for express report title. |
Method name | Brief description | |
bindCancelNode | The bindCancelNode method indicates to the title, that there is no need to exit title edit mode on selecting the specified node. | |
getPropertyValue | The getPropertyValue method returns value of the specified property. | |
getTranslateDialog | The getTranslateDialog method returns title translation dialog box. | |
getViewMode | The getViewMode method returns value of the View Mode checkbox for the express report title. | |
isLoaded | The isLoaded method determines whether the express report title is loaded. | |
refresh | The refresh method refreshes the express report title. | |
refreshAll | The refreshAll method refreshes all contents of the express report title. | |
refreshSelections | The refreshSelections method refreshes state of the express report title according to the model state. | |
updateContent | The updateContent method refreshes text of the express report title. |
Event name | Brief description | |
MetadataChanged | The MetadataChanged event occurs after changing title settings. | |
PropertyChanged | The PropertyChanged event occurs after changing value of the express title property. | |
RequestMetadata | The RequestMetadata event occurs when data source of the express report title contains no metadata. | |
SelectionChanged | The SelectionChanged event occurs after changing selection in express report title. |
Property name | Brief description | |
AutoHeight | The AutoHeight property determines whether title is automatically fit to height. | |
BackgroundColor | The BackgroundColor property determines background color for express report title. | |
EnableEdit | The EnableEdit property determines whether title can be edited. | |
Font | The Font property determines font for express report title. | |
HtmlText | The HtmlText property contains unformatted value of title text in the HTML markup language. | |
HtmlTitle | The HtmlTitle property contains unformatted value of title text in the HTML markup language. | |
IsControl | The IsControl property determines whether title is a control. | |
IsMultiLanguage | The IsMultiLanguage property determines whether it is possible to open a dialog box for title text translation during editing. | |
Options | The Options property determines express report title settings. | |
Size | The Size property determines express report title size. | |
Text | The Text property contains unformatted value of title text. | |
TextAlignment | The TextAlignment property determines horizontal alignment of title text. | |
TextColor | The TextColor property determines title text color. | |
TextWrapping | The TextWrapping property determines whether it is possible to wrap title text. | |
Title | The Title property contains formatted value of title text. | |
Visible | The Visible property determines title visibility. |
Method name | Brief description | |
beginEdit | The beginEdit method enables edit mode. | |
bindCancelNode | The bindCancelNode method cancels disabling of title edit mode on clicking the specified DOM node. | |
endEdit | The endEdit method disables edit mode. | |
getDropPanel | The getDropPanel method returns the title drop-down panel. | |
getEditMode | The getEditMode method determines whether title edit mode is enabled. | |
getTextEditor | The getTextEditor method returns title text editor. | |
getTranslateDialog | The getTranslateDialog method returns a dialog for title text translation. | |
getUnformattedText | The getUnformattedText method returns unformatted title text. | |
setFontColor | The setFontColor method sets title text font color. | |
setFontFamily | The setFontFamily method sets title font name. | |
setFontSize | The setFontSize method sets title text font size. | |
setIsBold | The setIsBold method sets bold style for title text. | |
setIsItalic | The setIsItalic method sets italic style for title text. | |
setIsUnderline | The setIsUnderline method sets underlining for title text. | |
unbindCancelNode | The unbindCancelNode method disables title edit mode on clicking the specified DOM node. | |
updateContent | The updateContent method updates title contents. |
Event name | Brief description | |
EditModeChanged | The EditModeChanged event occurs after edit mode is enabled or disabled. | |
HyperlinkClick | The HiperlinkClick event occurs on pressing a title hyperlink. | |
TextSelectionChanged | The TextSelectionChanged event occurs after changing text in the title editor. |
Property name | Brief description | |
Anchors | The Anchors property determines position of the component placed within container. | |
Animation | The Animation property sets animation parameters for component. | |
Bottom | The Bottom property sets bottom offset on placing the component within the LayoutPanel. | |
Content | The Content property sets the component contents. | |
ContextMenu | The ContextMenu property sets the context menu for the component. | |
Data | The Data property is used to store any custom data. | |
DataContext | The DataContext property contains an object with data. | |
Enabled | The Enabled property sets whether the component is enabled. | |
Height | The Height property determines the component height. | |
IsResizable | The IsResizable property determines whether the component can be resized. | |
IsRTL | The lsRTL property sets right to left text direction. | |
IsVisible | The IsVisible property determines whether the component is displayed. | |
Left | The Left property sets left offset on placing the component within the GridPanel. | |
Offset | The Offset property determines coordinates of root DOM node of a control. | |
Opacity | The Opacity property determines component transparency. | |
Parent | The Parent property determines a parent component of a control. | |
ParentNode | The ParentNode property sets parent DOM node. | |
ResourceKey | The ResourceKey property sets the resource key for the component. | |
Right | The Right property sets right offset on placing the component within the LayoutPanel. | |
Rotate | The Rotate property sets component rotation angle. | |
ShowToolTip | The ShowToolTip property determines whether the tooltip of the component can be displayed. | |
Style | The Style property sets component style. | |
TabIndex | The TabIndex property sets the order of the control element passing inside the container. | |
Tag | The Tag property sets JSON object associated with the component. | |
ToolTip | The ToolTip property determines text of component tooltip. | |
Top | The Top property sets top offset on placing the component within the GridPanel. | |
Value | The Value property sets the value to the component. | |
Width | The Width property sets the component width. |
Method name | Brief description | |
The addClass method adds a CSS class to the component. | ||
addEvent | The addEvent method adds an event handler to a DOM node. | |
addEventHandler | The addEventHandler method adds an event handler to a DOM node. | |
addEvents | The addEvents method adds an array of event handlers to a DOM node. | |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | ||
addStyleBySelector | The addStyleBySelector method creates a block that contains a style with the specified CSS selector. | |
The addToNode method adds a component to the specified node. | ||
bindEvents | The bindEvents method subscribes an element to all available events. | |
The clearStylesCache method clears cache of component styles. | ||
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | ||
The getClass method returns the current CSS classes of the component. | ||
The getCssStyle method returns style for the specified node. | ||
The getDomNode method returns main DOM node of the component. | ||
The getFocused method determines whether the component is focused. | ||
getFunctionByName | The getFunctionByName method returns function by name. | |
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. | |
The hasClass method determines whether the specified CSS class is set for root DOM node of the control. | ||
The hide method hides a control. | ||
The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed. | ||
The isResingNow method determines whether the component is being resized. | ||
refreshBindingProperty | The refreshBindingProperty method refreshes the bound property by name. | |
refreshItemsStyle | The refreshItemsStyle method refreshes CSS styles of child elements. | |
refreshStyle | The refreshStyle method refreshes element CSS styles. | |
The removeClass method removes CSS class from the component. | ||
The removeEvent method removes event handler from DOM node. | ||
removeEventHandler | The removeEventHandler method removes event handler from DOM node. | |
removeFromDOM | The removeFromDOM method removes node from the DOM structure. | |
The removeStateClasses method removes CSS classes of the component. | ||
The setDraggable method determines whether it is possible to drag component on the HTML page. | ||
The setFocus method sets the component focus. | ||
The setIsHovered method displays the component as on hover. | ||
The setIsPressed method displays the component as if clicked upon. | ||
The setOpacityIE8 method sets component transparency value in Internet Explorer 8. | ||
The setSize method establishes the sizes of the component. | ||
The show method displays a control. | ||
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. | |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | ||
The updateSize method updates the component size on changing the size of the container that contains the component. |
Event name | Brief description | |
Drag | The Drag event occurs on clicking and holding the left mouse button. | |
DragEnd | The DragEnd event occurs when dragging the component finishes. | |
DragStart | The DragStart event occurs when dragging the component starts. | |
OnContextMenu | The OnContextMenu event occurs on calling context menu of the component. | |
SizeChanged | The SizeChanged event occurs after the component is resized. | |
SizeChanging | The SizeChanging event occurs during component resize. |
Property name | Brief description | |
Data | The Data property associates a random object with this component. | |
Id | The Id property sets component identifier. | |
Settings | The Settings property sets the component parameters. |
Method name | Brief description | |
clone | The clone method creates a copy of object. It is not implemented in PP.Ui.Control. | |
dispose | The dispose method deletes the component. | |
getTypeName | The getTypeName method returns the name of the object type without the namespace, to which it belongs. |
See also: