src/components/kendoUI/datagridview/datagridview.component.ts
OnInit
DoCheck
DataGridView
AfterViewInit
| changeDetection | ChangeDetectionStrategy.OnPush |
| selector | wm-datagridview |
| styleUrls | ./datagridview.component.scss |
| templateUrl | ./datagridview.component.html |
constructor(serviceRef: WebMapService, refChange: ChangeDetectorRef, render2: Renderer2, elem: ElementRef, formBuilderRef: UntypedFormBuilder, webComponents: WebComponentsService, bringTopServ1: BringTopService)
|
||||||||||||||||||||||||
|
Parameters :
|
| dataUrl |
Type : string
|
| pageSizeInternal |
Type : number
|
| class |
Type : string
|
| model |
Type : any
|
| tabindex |
Type : string
|
| tooltip |
Type : string
|
| useCss |
Type : boolean
|
Default value : false
|
|
Property to know if the inline styles should not be applied. |
| CellEnter |
Type : EventEmitter<EventData>
|
| CellLeave |
Type : EventEmitter<EventData>
|
| Click |
Type : EventEmitter<EventData>
|
| CurrentCellChanged |
Type : EventEmitter<EventData>
|
| DoubleClick |
Type : EventEmitter<EventData>
|
| ItemSelectionChanged |
Type : EventEmitter<EventData>
|
| RowEnter |
Type : EventEmitter<EventData>
|
| SelectedRowChange |
Type : EventEmitter<EventData>
|
| Edit |
Type : EventEmitter<EventData>
|
| Sort |
Type : EventEmitter<EventData>
|
| ContextMenu |
Type : EventEmitter<EventData>
|
| DragDrop |
Type : EventEmitter<EventData>
|
| Enter |
Type : EventEmitter<EventData>
|
| GotFocus |
Type : EventEmitter<EventData>
|
| KeyDown |
Type : EventEmitter<KeyEventArgs>
|
| KeyPress |
Type : EventEmitter<EventData>
|
| KeyUp |
Type : EventEmitter<KeyEventArgs>
|
| Leave |
Type : EventEmitter<EventData>
|
| LostFocus |
Type : EventEmitter<EventData>
|
| MouseMove |
Type : EventEmitter<MouseEventArgs>
|
| Resize |
Type : EventEmitter<EventData>
|
| TextChanged |
Type : EventEmitter<EventData>
|
| Validated |
Type : EventEmitter<EventData>
|
| Validating |
Type : EventEmitter<EventData>
|
| arrowDownHandler | ||||||
arrowDownHandler(event: any)
|
||||||
|
Arrows down handler
Parameters :
Returns :
void
|
| arrowUpHandler | ||||||
arrowUpHandler(event: any)
|
||||||
|
Arrows up handler
Parameters :
Returns :
void
|
| beginEdit |
beginEdit()
|
|
Opens the editor in the current cell
Returns :
void
|
| cellClickHandler | |||
cellClickHandler(undefined)
|
|||
|
Handles the cellClick event.
Parameters :
Returns :
void
|
| cellCloseHandler | ||||||
cellCloseHandler(args: any)
|
||||||
|
Parameters :
Returns :
void
|
| Static cellEnterEventArgsExtractor | |||||||||
cellEnterEventArgsExtractor(event: any, component: DataGridViewComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| Static cellExtractor | |||||||||
cellExtractor(event: any, component: DataGridViewComponent)
|
|||||||||
|
Parameters :
Returns :
any[]
|
| Static cellLeaveEventArgsExtractor | |||||||||
cellLeaveEventArgsExtractor(event: any, component: DataGridViewComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| Static cellShowingEventArgsExtractor | |||||||||
cellShowingEventArgsExtractor(event: any, component: DataGridViewComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| checkboxCellHandler |
checkboxCellHandler(event: any, rowIndex: number, columnIndex: number)
|
|
Gets the checkbox click and send data to the server, it close the previous cell if it was in edition.
Returns :
void
|
| clickEvent | ||||||||
clickEvent(event: any)
|
||||||||
Decorators :
@serverEvent('Click')
|
||||||||
|
Handles the Click event.
Parameters :
Returns :
void
|
| datePickerCellCloseHandler |
datePickerCellCloseHandler()
|
|
Gets the date selected on DatePicker and send the data to the server.
Returns :
void
|
| doubleClick | ||||||||
doubleClick(event: any)
|
||||||||
Decorators :
@serverEvent('DoubleClick', DataGridViewComponent.cellExtractor)
|
||||||||
|
Handles the double click event.
Parameters :
Returns :
void
|
| fetchItems |
fetchItems()
|
|
Returns :
void
|
| getCheckBoxValue | ||||
getCheckBoxValue(value)
|
||||
|
Parameters :
Returns :
boolean
|
| getDisplayElement |
getDisplayElement()
|
|
Gets display element retrieving the k-grid element from kendo-grid
Returns :
HTMLElement | undefined
HTML display element or undefined if element is not rendered |
| getDisplayValue | ||||||
getDisplayValue(column, value)
|
||||||
|
Parameters :
Returns :
string
|
| getFormat | ||||
getFormat(column)
|
||||
|
Parameters :
Returns :
string
|
| getFormattedColumns |
getFormattedColumns()
|
|
Returns the columns after updating the field values to be compatible with the KendoGrid.
Returns :
any[]
{any[]} |
| getItemValue |
getItemValue(dataItem: any, kendoColField: string)
|
|
Returns the correct data item value.
Returns :
string
{string} |
| getSelectedRows | ||||||
getSelectedRows(obj: any)
|
||||||
|
Parameters :
Returns :
void
|
| getSelectionModeFromModel | ||||||
getSelectionModeFromModel(modelSelectionMode: number)
|
||||||
|
Parameters :
Returns :
string
|
| handleCellChangeEvents | ||||||
handleCellChangeEvents(eventData: EventData)
|
||||||
Decorators :
@serverEvent('RowEnter', DataGridViewComponent.cellEnterEventArgsExtractor)
|
||||||
|
Handles the CurrentCellChanged event.
Parameters :
Returns :
void
|
| isRowSelected | ||||||
isRowSelected(e: RowArgs)
|
||||||
|
Handles the row selection of the grid.
Parameters :
Returns :
boolean
|
| keyDownHandler | ||||||
keyDownHandler(event: any)
|
||||||
|
Keys down handler
Parameters :
Returns :
void
|
| loadColumns |
loadColumns()
|
|
Get the Grid's Columns object
Returns :
void
|
| loadFrozenRows |
loadFrozenRows()
|
|
Get the Grid's Frozen rows set
Returns :
void
|
| loadPage |
loadPage()
|
|
Returns :
void
|
| ngAfterViewInit |
ngAfterViewInit()
|
|
Returns :
void
|
| ngDoCheck |
ngDoCheck()
|
|
Returns :
void
|
| ngOnInit |
ngOnInit()
|
|
Returns :
void
|
| Static selectedRowChangeEventArgsExtractor | |||||||||
selectedRowChangeEventArgsExtractor(event: any, component: DataGridViewComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| selectsCurrentCellContent |
selectsCurrentCellContent()
|
|
Selects the current cell content
Returns :
void
|
| setRowAndColProperties |
setRowAndColProperties(rowIndex: number, colIndex: number)
|
|
Returns :
void
|
| setSelectableSettings |
setSelectableSettings()
|
|
Returns :
void
|
| setSortableSettings |
setSortableSettings()
|
|
Sets the sortableSettings object
Returns :
void
|
| sortChange | ||||||
sortChange(sort: SortDescriptor)
|
||||||
|
Prepares the data for the server side request which order the dataview
Parameters :
Returns :
void
|
| tabHandler | ||||||
tabHandler(event: any)
|
||||||
|
Tabs handler
Parameters :
Returns :
void
|
| toolTipFunction |
toolTipFunction(columnW: number, spanW: number, value)
|
|
This is a function to evaluate if the tooltip needs to be shown or not using the span and column width
Returns :
any
|
| triggerEditHandler | ||||||
triggerEditHandler(value: any)
|
||||||
|
Parameters :
Returns :
void
|
| updateLocalCellValue | ||||||
updateLocalCellValue(formGroup: UntypedFormGroup)
|
||||||
|
Updates local cell value
Parameters :
Returns :
void
|
| applyCellStyle |
applyCellStyle(rowIndex: number, columnIndex: number)
|
|
Apply's the cell style based on row and cell styles
Returns :
any
|
| applyColumnStyle | ||||||
applyColumnStyle(columnStyle: any)
|
||||||
|
Parameters :
Returns :
any
|
| applyFocus |
applyFocus()
|
|
Applies focus to current row and current column inside of grid component.
Returns :
void
|
| bindBlurEventToTableElements | ||||||||
bindBlurEventToTableElements(elementsCollection: any)
|
||||||||
|
Binds the onblur event to every element in the collection
Parameters :
Returns :
void
|
| bindsFocusOutEventToGrid |
bindsFocusOutEventToGrid()
|
|
Gets the dom elements collections and then binds the onblur event to every element
Returns :
void
|
| calculateStyle |
calculateStyle(rowIndex: number, columnIndex: number)
|
|
Calculates the style for a cell and stores it in a temporal structure to avoid calculated it twice
Returns :
any
|
| createFormGroup | ||||||
createFormGroup(dataItem: any)
|
||||||
|
creates form group object used in the grid's edition
Parameters :
Returns :
UntypedFormGroup
|
| detectChangesExecution |
detectChangesExecution()
|
|
Execute the detectChanges() function on the subscription of the detectChanges, this subscription is in the control.component.ts WinForms
Returns :
void
|
| editEventHandler | ||||||
editEventHandler(eventData: EventData)
|
||||||
Decorators :
@serverEvent('Edit', GridComponent.EditExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| Static EditExtractor | |||||||||
EditExtractor(event: any, component: GridComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| getPageParams |
getPageParams()
|
|
Return an HttpParams object with the page data.
Returns :
HttpParams
|
| getStoredStyle |
getStoredStyle(rowIndex: number, columnIndex: number)
|
|
Checks if the style for a specific cell is already stored in the structure and returns it
Returns :
any
|
| hasTheGridLostFocus | ||||||||
hasTheGridLostFocus(event: any)
|
||||||||
|
Checks if the user has leave the grid, if so, triggers the leave event
Parameters :
Returns :
void
|
| isDescendant |
isDescendant(parent: any, child: any)
|
|
Checks if an element is descedant of another in the DOM tree
Returns :
boolean
|
| kendoToWebMapColField | ||||||
kendoToWebMapColField(kendoColumnField: string)
|
||||||
|
Returns the WebMap column field value based on the kendo column field. This function gets the WebMap value after using the webMapToKendoColField.
Parameters :
Returns :
string
{string} |
| moveFrozenRows | ||||||
moveFrozenRows(maxFrozen: number)
|
||||||
|
Parameters :
Returns :
void
|
| ngOnDestroy |
ngOnDestroy()
|
|
OnDestroy life-cycle hook
Returns :
void
|
| originalStyle |
originalStyle(rowIndex: number, columnIndex: number)
|
|
Returns original Style from a cell
Returns :
any
|
| pageChange | ||||||||
pageChange(event: PageChangeEvent)
|
||||||||
|
Handles the page change event.
Parameters :
Returns :
void
|
| setRowStyle |
setRowStyle()
|
|
inserts a style inside the grid's DOM in order to handle the rowheight
Returns :
void
|
| sortEventHandler | ||||||
sortEventHandler(eventData: EventData)
|
||||||
Decorators :
@serverEvent('Sort', GridComponent.SortExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| Static SortExtractor | |||||||||
SortExtractor(event: any, component: GridComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| tryCloseGridEdit |
tryCloseGridEdit()
|
|
Trys close grid edit
Returns :
void
|
| webMapToKendoColField | ||||||
webMapToKendoColField(webMapColumnField: string)
|
||||||
|
Returns a valid KendoGrid column field value.
Parameters :
Returns :
string
{string} |
| Private addModifierKey | ||||||
addModifierKey(keyCode: number)
|
||||||
|
Add a modifier key if it applies.
Parameters :
Returns :
void
|
| applyAnchorProperty |
applyAnchorProperty()
|
|
Applies anchor property
Returns :
void
|
| applyAutoSizeProperty |
applyAutoSizeProperty()
|
|
Applies auto size property Fix the current control dimensions to fit its content according to the autosize and autosizemode properties
Returns :
void
|
| blur | ||||||
blur(event: any)
|
||||||
Decorators :
@serverEvent('LostFocus')
|
||||||
|
Parameters :
Returns :
void
|
| bringToFront |
bringToFront()
|
|
Bring to the front the current control.
Returns :
void
|
| Private bringToFrontService |
bringToFrontService()
|
|
Bring to front service
Returns :
void
|
| Protected calculateTabOrder |
calculateTabOrder()
|
|
Calculates tab order according to model value and TabStop
Returns :
any
tab order |
| canSubscribeToErrorProvider |
canSubscribeToErrorProvider()
|
|
Returns true if the control is ready to subscribe to the ErroProvider.
Returns :
boolean
|
| change | ||||||
change(event: any)
|
||||||
Decorators :
@serverEvent('TextChanged')
|
||||||
|
Parameters :
Returns :
void
|
| changeChildEnableStatus |
changeChildEnableStatus(parent: any, value: boolean)
|
|
Property EnabledInternal: is used to check the original enabled state of any control. IMPORTANT: This property is modify only when the component is modified by himself its parent can't modify it
Returns :
void
|
| checkDetectChangesAfterLeave |
checkDetectChangesAfterLeave()
|
|
Over ride if the component need to check for changes after losses focus
Returns :
void
|
| checkErrorProvider |
checkErrorProvider()
|
|
This function handles the ErrorProvider for each component
Returns :
void
|
| contextMenu | ||||||
contextMenu(event: any)
|
||||||
|
Parameters :
Returns :
void
|
| createErrorProvider |
createErrorProvider()
|
|
Auxiliary function that creates the image of the errorProvider, this to reduce the cognitive complexity of the function checkErrorProvider
Returns :
void
|
| currentWebMapService |
currentWebMapService()
|
|
Current instance of the static WebMapService
Returns :
WebMapService
{*} |
| detectChanges |
detectChanges()
|
|
Triggers a detect change action
Returns :
void
|
| detectChangesSubscribe |
detectChangesSubscribe()
|
|
Each component that have the isForm as true should implement this method
Returns :
void
|
| dragDrop | ||||||||
dragDrop(event: any)
|
||||||||
Decorators :
@serverEvent('DragDrop', ControlComponent.dragDropEventArgsExtractor)
|
||||||||
|
Handles the dragdrop event. Should stop server propagation if allowdrop is false;
Parameters :
Returns :
boolean
|
| Static dragDropEventArgsExtractor | |||||||||
dragDropEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| enter | ||||||
enter(event: any)
|
||||||
Decorators :
@serverEvent('Enter', ControlComponent.EnterEventArgsExtractor, undefined)
|
||||||
|
Parameters :
Returns :
void
|
| Static EnterEventArgsExtractor | |||||||||
EnterEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| errorValueAux |
errorValueAux()
|
|
Auxiliary function that returns values in some especial cases, this to reduce the cognitive complexity of the function checkErrorProvider
Returns :
number
|
| focus | ||||||
focus(event: any)
|
||||||
Decorators :
@serverEvent('GotFocus')
|
||||||
|
Parameters :
Returns :
void
|
| getElementErrorProviderStyle | ||||||
getElementErrorProviderStyle(element)
|
||||||
|
Get the corresponding Style depending of the TagName
Parameters :
Returns :
string
|
| getElementsWidth |
getElementsWidth()
|
|
Calculate the total width, including all siblings elements.
Returns :
number
|
| getExtraElement |
getExtraElement()
|
|
Gets the extra element affecting the position of the error provider.
Returns :
any
|
| Protected getNewPositions |
getNewPositions()
|
|
Gets new positions Analyze the children components and get the new sizes for this control with the autoSizeMode
Returns :
literal type
new positions |
| getStyle |
getStyle()
|
|
Gets the new Style
Returns :
Style
|
| getStyleDisplay |
getStyleDisplay()
|
|
Method to allow each component to manage its own display property Example : {display: 'block'}
Returns :
string
|
| getType |
getType()
|
|
Gets string indicating the type
Returns :
string
type |
| getWrapperElement |
getWrapperElement()
|
|
Gets the wrapper element of the control in the DOM.
Returns :
any
|
| Private hideToolTipDirective |
hideToolTipDirective()
|
|
Hides tool tip directive
Returns :
void
|
| isBindedEvent | ||||||||
isBindedEvent(event: string)
|
||||||||
|
Indicates if an event is binded in the server or not.
Parameters :
Returns :
boolean
|
| isComponentReady |
isComponentReady()
|
|
Determines whether component is ready in the DOM
Returns :
boolean
true if component ready |
| Protected isCustomControl |
isCustomControl()
|
|
Check if this control is a custom editor for the c1flexgrid component. otherwise it returns False.
Returns :
boolean
Returns True if the control is within a custom editor column, otherwise it returns False. |
| isUserControl |
isUserControl()
|
|
Gets if is usercontrol or not
Returns :
boolean
|
| keyDown | ||||||
keyDown(event: any)
|
||||||
Decorators :
@serverEvent('KeyDown', ControlComponent.keyEventArgsExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| Static keyEditEventArgsExtractor | |||||||||
keyEditEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| Static keyEventArgsExtractor | |||||||||
keyEventArgsExtractor(event: any, component: ControlComponent)
|
|||||||||
|
Parameters :
Returns :
any
|
| keyPress | ||||||
keyPress(event: any)
|
||||||
Decorators :
@serverEvent('KeyPress', ControlComponent.keyPressEventArgsExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| Static keyPressEventArgsExtractor | ||||||||||||
keyPressEventArgsExtractor(event: any, component: ControlComponent)
|
||||||||||||
|
Parameters :
Returns :
any
|
| keyUp | ||||||
keyUp(event: any)
|
||||||
Decorators :
@serverEvent('KeyUp', ControlComponent.keyEventArgsExtractor)
|
||||||
|
Parameters :
Returns :
void
|
| leave | ||||||
leave(event: any)
|
||||||
Decorators :
@serverEvent('Leave')
|
||||||
|
Parameters :
Returns :
void
|
| leaveEventsHandler | ||||||
leaveEventsHandler(event: any)
|
||||||
|
Triggers the leave-validating-validated events in the correct order.
Parameters :
Returns :
void
|
| markForCheck |
markForCheck()
|
|
Marks for check Marks component to be checked by the next detect changes action
Returns :
void
|
| mouseEnter | ||||||||
mouseEnter(event: any)
|
||||||||
|
Mouses enter Shows tooltip if need it
Parameters :
Returns :
void
|
| mouseLeave | ||||||||
mouseLeave(event: any)
|
||||||||
|
Mouses leave Hides tooltip if need it
Parameters :
Returns :
void
|
| mouseMove | ||||||
mouseMove(event: any)
|
||||||
|
MouseMove event emit the data for every mouseMove event
Parameters :
Returns :
void
|
| ngAfterViewChecked |
ngAfterViewChecked()
|
|
Returns :
void
|
| notifyErrorProvider |
notifyErrorProvider()
|
|
Auxiliary function notifying that the errorProvider has been rendered, this to reduce the cognitive complexity of the function checkErrorProvider
Returns :
void
|
| notifyEvent |
notifyEvent(eventName: string, event: any)
|
|
Notifies leave
Returns :
void
|
| Protected notifyParentAutoSize |
notifyParentAutoSize()
|
|
Notifies parent auto size
Returns :
void
|
| notifyWindowToBringTop | ||||||||
notifyWindowToBringTop(event: any)
|
||||||||
|
Notifies the window to bring top When a control is clicked or focused in the screen
Parameters :
Returns :
void
|
| processSpecialDock | ||||||||||||||||
processSpecialDock(component: ControlComponent, size: ISize, offsets: IOffsets)
|
||||||||||||||||
|
Process special dock for the current Control. you should override the method in the specify control.
Parameters :
Returns :
literal type
special dock. new size and offset for the dock context. |
| Private removeModifierKey | ||||||
removeModifierKey(keyCode: number)
|
||||||
|
Remove a modifier key if it applies.
Parameters :
Returns :
void
|
| Private removeStyleProperty | ||||||||
removeStyleProperty(property: string)
|
||||||||
|
Sets style property Updates model values for Style
Parameters :
Returns :
void
|
| resize | ||||||||
resize(event: any)
|
||||||||
Decorators :
@serverEvent('Resize')
|
||||||||
|
Trigger the event resize defined through the output member.
Parameters :
Returns :
void
|
| resolvePendingTabSubscriptions |
resolvePendingTabSubscriptions()
|
|
Resolves pending tab subscriptions for components that were resolved as pending parent
Returns :
void
|
| Protected setChildIndex |
setChildIndex()
|
|
Sets child index to HTML zindex property
Returns :
void
|
| setDisplayElementOriginalDimensions |
setDisplayElementOriginalDimensions()
|
|
Sets display element original dimensions
Returns :
void
|
| setMyStyle |
setMyStyle()
|
|
Returns a valid style object to be applied according to the styling information set in the control's model
Returns :
literal type
|
| shouldApplyFocus |
shouldApplyFocus()
|
|
Determines whether applyFocus method should be called.
Returns :
boolean
true if apply focus |
| Private shouldValidateErrorProvider |
shouldValidateErrorProvider()
|
|
Determines if error provider should be validated
Returns :
boolean
true if it has to validate error provider |
| Private showTooltipDirective |
showTooltipDirective()
|
|
Shows tooltip directive
Returns :
void
|
| specialStyle |
specialStyle()
|
|
Specials style. Override this method if you want to handle special style for the dock
Returns :
void
style |
| Private startAnchorProcess |
startAnchorProcess()
|
|
Starts anchor process After rendering a new window the anchor process is triggered before the docking process to ensure that the measure to edges are correct and the anchor distances are calculated properly
Returns :
void
|
| subscribeErrorProvider |
subscribeErrorProvider()
|
|
This function handles the subscription to the ErrorProvider.
Returns :
void
|
| Private tooltipHandler |
tooltipHandler()
|
|
Tooltips handler
Returns :
void
|
| Protected updateDockProperty |
updateDockProperty()
|
|
compare if the dock is different and call the dockChange
Returns :
void
|
| validated | ||||||
validated(event: any)
|
||||||
Decorators :
@serverEvent('Validated')
|
||||||
|
Parameters :
Returns :
void
|
| validating | ||||||
validating(event: any)
|
||||||
Decorators :
@serverEvent('Validating')
|
||||||
|
Parameters :
Returns :
void
|
| verifyErrorProvider | ||||||
verifyErrorProvider(event: EventData)
|
||||||
|
Function that verifies that another component does not duplicate the same errorProvider
Parameters :
Returns :
void
|
| cellType |
Default value : CellType
|
| clickedCell |
Type : any
|
|
Keeps a reference to the clicked cell. |
| Static dataGridViewMapperId |
Type : string
|
Default value : 'dtGrdVw'
|
| datePickerValueChanged |
Type : Date
|
| datePickerValueOriginal |
Type : Date
|
| defaultDataUrl |
Type : string
|
Default value : 'api/datagridview'
|
| frozenRows |
Type : any[]
|
Default value : []
|
| getColumnsUrl |
Default value : `${this.defaultDataUrl}/GetColumns`
|
|
Url to get the Grid's Columns set |
| getFrozenRows |
Default value : `${this.defaultDataUrl}/GetFrozenRows`
|
|
URL to get the set of frozen rows in the entire grid |
| getPageDataUrl |
Default value : `${this.defaultDataUrl}/GetPage`
|
|
Url to get the page data |
| gridSelection |
Type : number[]
|
Default value : []
|
| longDateFormat |
Type : string
|
Default value : 'D'
|
| shortDateFormat |
Type : string
|
Default value : 'd'
|
| columns |
Type : any[]
|
| Static editEventArgsMapperId |
Type : string
|
Default value : 'DtVntRgs'
|
| formGroup |
Type : UntypedFormGroup
|
| gridEl |
Type : ElementRef
|
Decorators :
@ViewChild('grid', {static: false})
|
| gridView |
Type : GridDataResult
|
| items |
Type : any[]
|
| loading |
Type : boolean
|
| selectableSettings |
Type : SelectableSettings
|
| skip |
Type : number
|
Default value : 0
|
| sort |
Type : SortDescriptor
|
| sortableSettings |
Type : SortSettings
|
| Static sortEventArgsMapperId |
Type : string
|
Default value : 'SrtVntRgs'
|
| styleContainer |
Type : ElementRef
|
Decorators :
@ViewChild('styleContainer', {static: false})
|
| styles |
Type : any[]
|
| stylesCalculated |
Type : any[]
|
| Private _font |
Type : Font
|
| _model |
Type : any
|
| controlFlag |
Default value : true
|
|
The controlFlag help us to avoid twice calls. |
| detectChangesSubscription |
Type : string
|
|
Detect changes subscription of control component |
| displayElementInner |
Type : HTMLElement | undefined
|
|
the element that is shown in the DOM. Should be override in each component. |
| Private Static DIV_TAG |
Type : string
|
Default value : 'DIV'
|
| errorIsRendered |
Default value : false
|
|
This flag lets the controller know if the error provider has been rendered. |
| errorIsShowed |
Default value : false
|
|
This flag allows the controller to display the errorProvider. |
| hasErrorProviderSubscription |
Default value : false
|
|
Flag indicating whether the control has the error provider subscription. |
| isControlComponent |
Default value : true
|
|
Validate the component inherits from controlComponent or is an instance of controlComponent |
| isInsideGridCell |
Type : boolean
|
|
This should be set from the container where the component is going to be rendered Determines whether the component is render dynamically inside a grid cell(using a container mechanism like wm-container) |
| Static modifierKeys |
Default value : Keys.none
|
| originalHeight |
Type : number
|
|
Original height of control component |
| originalVisibility |
Type : boolean
|
|
Original visibility of control component Keeps a record of the current visible value to detect changes; |
| originalWidth |
Type : number
|
|
Original width of control component |
| registerManually |
Default value : false
|
|
A reference for managing component registration manually |
| shortcut |
Type : string
|
|
Shortcut property of basecontrolcomponent |
| showUnderline |
Default value : false
|
|
Property to trigger the underline of the shortcuts |
| style |
Type : Style
|
|
This object contains the style information for the component. |
| syncCompleteSubscription |
Type : string
|
|
Sync complete subscription of control component |
| tabDirective |
Type : ControlsDirective
|
Decorators :
@ViewChild(ControlsDirective, {static: false})
|
|
View child of tab directive |
| tooltipDir |
Type : TooltipDirective
|
Decorators :
@ViewChild(TooltipDirective)
|
|
View child of control component |
| triggerShortcutUnderlineSubscription |
Type : Subscription
|
|
Shortcut underline subcription of a component |
| afterFirstCall |
Default value : false
|
|
After first call of control component. Flag used to know if the control have been called in the ngAfterViewInit |
| anchorApplied |
Default value : -1
|
|
Anchor applied of control component Holds the currently applied anchor property -1 otherwise. |
| autoSizeApplied |
Default value : false
|
|
Auto size applied of control component |
| children |
Type : []
|
Default value : []
|
|
Controls of control component Array of controls that are children of this component |
| containerTabOrderService |
Type : ContainerTabOrderService
|
|
Container tab order service of control component base component |
| currentAutoSizeMode |
Default value : -1
|
|
Current auto size mode of control component |
| currentDock |
Type : number
|
Default value : 0
|
|
Current dock of control component |
| currentDockingOrder |
Type : []
|
Default value : []
|
|
Current docking order of control component. Array of children ids |
| customControl |
Default value : false
|
|
Custom control property obtains the value when is calculated in ngAfterViewInit, it determines if it is a component rendered inside of a custom control column of WFNETC1 WE SHOULD TRY TO REMOVE THIS PROPERTY, WINFORMS COMPONENTS SHOULD NOT KNOW THAT A COMPONENT FROM WFNETC1 EXISTS. |
| defaultControls |
Type : []
|
Default value : []
|
|
Default controls of control component. Internal array of the child with special docking |
| errorProviderIconWasCreated |
Type : boolean
|
|
Flag to know if the error provider icon is created. |
| internalTabOrder |
Type : any
|
|
Internal tab order of control component base component |
| isApplyingFocus |
Type : boolean
|
|
Optional flag to determine when the component is calling the applyFocus method. |
| lastErrorProviderMessage |
Default value : undefined
|
|
Last error provider message of control component base component to cached value and avoid multiple unnecessary function calls |
| lastZIndex |
Type : number
|
Default value : 0
|
|
Last zIndex of control component |
| originalTooltipText |
Type : string
|
|
Original tooltip text of control component base component |
| specialDock |
Default value : false
|
|
Special dock of control component. Mark to process the dock with special values |
| tabNodeReference |
Type : TabNode
|
|
Tab node reference of base control component |
| tooltipDisplayed |
Type : boolean
|
|
Tooltip displayed of control component base component |
| selectedRowsIndices | ||||||
getselectedRowsIndices()
|
||||||
setselectedRowsIndices(indexes: number[])
|
||||||
|
Sets the selected rows indices
Parameters :
Returns :
void
|
| readonly |
getreadonly()
|
| isInEditionMode | ||||||
getisInEditionMode()
|
||||||
|
Gets the Grid's IsInEditionMode value
Returns :
boolean
|
||||||
setisInEditionMode(value: boolean)
|
||||||
|
Sets the Grid's IsInEditionMode value
Parameters :
Returns :
void
|
| selectCurrentCellContent |
getselectCurrentCellContent()
|
|
Gets the Grid's SelecteCurrentCellContent value
Returns :
boolean
|
| currentRow | ||||||
getcurrentRow()
|
||||||
|
Gets the Grid's current row index
Returns :
number
|
||||||
setcurrentRow(value: number)
|
||||||
|
Sets the Grid's current row index
Parameters :
Returns :
void
|
| currentColumn | ||||||
getcurrentColumn()
|
||||||
|
Gets the Grid's current column index
Returns :
number
|
||||||
setcurrentColumn(value: number)
|
||||||
|
Sets the Grid's current column index
Parameters :
Returns :
void
|
| cellTipsWidth |
getcellTipsWidth()
|
| cellTipsDelay |
getcellTipsDelay()
|
| rowHeadersVisible |
getrowHeadersVisible()
|
| displayElement | ||||||
getdisplayElement()
|
||||||
|
Gets display element calculated using getDisplayElement function
Returns :
HTMLElement | undefined
|
||||||
setdisplayElement(value: HTMLElement | undefined)
|
||||||
|
Sets displayElement innerProperty
Parameters :
Returns :
void
|