TitleBox

Namespace: PP.Exp.Ui;

Inheritance hierarchy

Object

Control

GxTitle

TitleBox

Description

The TitleBox class implements view of express report title.

Syntax

PP.initClass(PP.Exp.Ui.TitleBox, PP.Mb.Ui.GxTitle, "TitleBox", [PP.Exp.Ui.ITitleBox, PP.INotifyPropertyChanged]);

Comments

The TitleBox class implements the TitleBox component.

Constructor

  Constructor name Brief description
sub_image.gif TitleBox The TitleBox constructor creates an instance of the TitleBox component.

Properties

  Property name Brief description
property_image.gif DimTreeMode The DimTreeMode property determines a data view that will use the title.
property_image.gif EditMode The EditMode property sets value of the Edit Mode checkbox for the express report title.
property_image.gif EnableEdit The EnableEdit property determines whether express report title can be edited.
property_image.gif Instance The Instance property returns express report title.
property_image.gif IsMultiLanguage The IsMultiLanguage property determines whether title translation button is displayed when the title is edited.
property_image.gif NeedValidate The NeedValidate property determines whether the title needs to be validated.
property_image.gif Options The Options property sets and returns settings of the express report title.
property_image.gif Service The Service property determines an object of service for working with title.
property_image.gif Source The Source property sets a data source for express report title.

Methods

  Method name Brief description
sub_image.gif bindCancelNode The bindCancelNode method indicates to the title, that there is no need to exit title edit mode on selecting the specified node.
sub_image.gif getPropertyValue The getPropertyValue method returns value of the specified property.
sub_image.gif getTranslateDialog The getTranslateDialog method returns title translation dialog box.
sub_image.gif getViewMode The getViewMode method returns value of the View Mode checkbox for the express report title.
sub_image.gif isLoaded The isLoaded method determines whether the express report title is loaded.
sub_image.gif refresh The refresh method refreshes the express report title.
sub_image.gif refreshAll The refreshAll method refreshes all contents of the express report title.
sub_image.gif refreshSelections The refreshSelections method refreshes state of the express report title according to the model state.
sub_image.gif updateContent The updateContent method refreshes text of the express report title.

Events

  Event name Brief description
event_image.gif MetadataChanged The MetadataChanged event occurs after changing title settings.
event_image.gif PropertyChanged The PropertyChanged event occurs after changing value of the express title property.
event_image.gif RequestMetadata The RequestMetadata event occurs when data source of the express report title contains no metadata.
event_image.gif SelectionChanged The SelectionChanged event occurs after changing selection in express report title.

Properties inherited from the class GxTitle

  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.

Methods inherited from the class GxTitle

  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.

Events inherited from the class GxTitle

  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.

Properties inherited from the class Control

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property determines component animation parameters.
Bottom The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
Content The Content property determines component contents.
ContextMenu The ContextMenu property determines a component's context menu.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether a component can be used.
Height The Height property determines component height.
IsRTL The IsRTL property determines whether component elements are aligned to the right.
IsVisible The IsVisible property determines whether a component is displayed.
Left The Left property determines a left margin if a component is placed inside GridPanel.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property determines a parent DOM node.
ResourceKey The ResourceKey property determines a component resource key.
Right The Right property determines a right margin if a component is placed inside LayoutPanel.
Rotate The Rotate property determines a component rotation angle.
ShowToolTip The ShowToolTip property determines whether a tooltip of the component can be displayed.
Style The Style property determines a component style.
TabIndex The TabIndex property determines the order of the control element passing inside the container.
Tag The Tag property determines a JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property determines a top margin if a component is placed inside GridPanel.
Value The Value property determines a component value.
Width The Width property determines component width.

Methods inherited from the class Control

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

The removeClass method removes CSS class from the component.
removeEventHandler The removeEventHandler method removes event handler from DOM node.
removeFromDOM The removeFromDOM method removes node from the DOM structure.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

  Event name Brief description
Drag The Drag event occurs on clicking and holding the 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.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

PP.Exp.Ui