Property | Type | Description | |
---|---|---|---|
m_bv | BrowseViewer | ||
m_dyTopOfScreenOffset | int | ||
m_fHandlingMouseUp | bool | ||
m_fMouseUpEnabled | bool | ||
m_fSelectedRowHighlighting | SelectionHighlighting | ||
m_fakeFlid | int | ||
m_hvoOldSel | int | ||
m_hvoRoot | int | ||
m_iSelIndex | int | ||
m_iTopOfScreenObjectForScrollPosition | int | ||
m_id | string | ||
m_nodeSpec | |||
m_rootObjectHasBeenSet | bool | ||
m_sda | ISilDataAccessManaged | ||
m_selectedIndex | int | ||
m_sortItemProvider | ISortItemProvider | ||
m_stringTable | SIL.Utils.StringTable | ||
m_tagMe | int | ||
m_wantScrollIntoView | bool | ||
m_xbvvc | SIL.FieldWorks.Common.Controls.XmlBrowseViewBaseVc | ||
m_ydSelBottom | int | ||
m_ydSelScrollPos | int | ||
m_ydSelTop | int |
Property | Type | Description | |
---|---|---|---|
DoMouseWheelVScroll | bool | ||
DoSelectionSideEffects | void | ||
FireSelectionChanged | bool | ||
GetCurrentTableCellInfo | void | ||
GetNewSelectionObject | int | ||
GetRowIndexFromSelection | int | ||
GetStringList | string[] | ||
InitializeComponent | void | ||
LocationOfSelectedRow | |||
MakeSelectionAt | IVwSelection | ||
RemoveRootBoxSelectionOnIdle | bool | ||
RestoreScrollPosition | bool | ||
SetDefaultInsertionPointInRow | bool | ||
SetSelectedIndex | void | ||
ShouldConvertDummiesInView | bool | ||
UpdateSelectedRow | bool |
Method | Description | |
---|---|---|
ClearValues ( ) : void |
Clear dangerous data values out of any of your decorated SDAs that require it.
|
|
ColumnSortedFromEnd ( int icol ) : bool |
a look up table for getting the correct version of strings that the user will see.
|
|
GetColWidthInfo ( ) : VwLength[] |
Get the widths of the columns as VwLengths (for the view tables).
|
|
GetCorrespondingPropertyName ( string property ) : string |
Gets the name of the corresponding property.
|
|
HvoAt ( int index ) : int |
Get the HVO of the object at the specified index.
|
|
Init ( XCore mediator, System configurationParameters ) : void |
Allows xCore-specific initialization. We don't need any.
|
|
Init ( |
Inits the specified node spec.
|
|
MakeRoot ( ) : void |
Make the root box.
|
|
OnDeleteRecord ( object commandObject ) : bool |
Called when [delete record].
|
|
OnDisplayDeleteRecord ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool |
see if it makes sense to provide the "delete record" command now
|
|
OnExportText ( object args ) : bool |
Export the contents of the browse view to the debug window. Answer false so other browse views can export theirs also.
|
|
OnPasteFixTssEvent ( EditingHelper sender, FwPasteFixTssEventArgs e ) : void |
If the text for pasting is too long, truncate it and warn the user.
|
|
OnPrepareToRefresh ( object args ) : bool |
Called when [prepare to refresh].
|
|
OnPrint ( object args ) : bool |
Tries to be smart about whether our RootSite should print or not.
|
|
OnRequestDebugInfo ( object commandObj ) : bool |
Called when [request debug info].
|
|
OnRestoreScrollPosition ( object args ) : bool |
Called through mediator by reflection. (Maybe?) This routine attempts to restore the scroll position previously saved by OnSaveScrollPosition. Specifically, it attempts to scroll to a position such that the top of the object at index m_iTopOfScreenObjectForScrollPosition is m_dyTopOfScreenOffset pixels below the top of the client area (or above, if m_dyTopOfScreenOffset is negative).
|
|
OnSaveScrollPosition ( object args ) : bool |
Called through mediator by reflection. Save the current scroll position for later restoration, in a form that will survive having the view contents replaced by a lazy box (that is, it's not good enough to just save AutoScrollPosition.y, we need enough information to create a selection at the top of the screen and get a corresponding selection back there. This class implements this by figuring out the index of the record at the top of the screen and saving that.
|
|
PostLayoutInit ( ) : void |
After we have our true size, make sure the interesting row is visible.
|
|
PropChanged ( int hvo, int tag, int ivMin, int cvIns, int cvDel ) : void |
|
|
RefreshDisplay ( ) : bool |
|
|
SetScrollBarParameters ( |
Set a controlling scrollbar's parameters using information this object owns.
|
|
SetSelectedRowHighlighting ( ) : void |
Cause the behavior to switch to the current setting of ReadOnlyBrowse. Override if the behaivor should be different than this.
|
|
XmlBrowseViewBase ( ) : System |
Initializes a new instance of the T:XmlBrowseViewBase class.
|
Method | Description | |
---|---|---|
AdjustScrollRange1 ( int dxdSize, int dxdPosition, int dydSize, int dydPosition ) : bool |
Handle the special aspects of adjusting the scroll position for a table of cells like we have in the browse view. See LT-3607 for details of what can go wrong without this override.
|
|
CreateSelectionRestorer ( ) : SIL.FieldWorks.Common.RootSites.SelectionRestorer |
Creates a new selection restorer.
|
|
Dispose ( bool disposing ) : void |
Clean up any resources being used.
|
|
DoSelectAndScroll ( int hvo, int index ) : void |
Does the select and scroll.
|
|
DoSelectionSideEffects ( IVwSelection sel ) : void |
Common code to HandleSelectionChange and MouseDown.
|
|
EnsureDefaultSelection ( ) : void |
A browse view does not HAVE to have a selection; forcing one (e.g., after clicking on a check box) and scrolling to the one we made at the start of the view is very disconcerting.
|
|
GetRowSelection ( int index ) : IVwSelection |
Gets the row selection.
|
|
HandleSelectionChange ( IVwRootBox prootb, IVwSelection vwselNew ) : void |
Notifies us that the selection changed. When next idle, we want to delete any unhelpful selection.
|
|
OnGotFocus ( |
Because this is a simple root site, which is derived from UserControl, we can't prevent MouseDown from giving it focus. But we can give other linked windows a chance to take it back.
|
|
OnKeyDown ( |
Handle the OnKeyDown event
|
|
OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void |
Overridden to fix TE-4146
|
|
OnMouseDown ( MouseEventArgs e ) : void |
MouseUp actions on XmlBrowseView should only be enabled if a preceeding MouseDown occured in the view.
|
|
OnMouseUp ( MouseEventArgs e ) : void |
Process left or right mouse button down
|
|
OnMouseWheel ( MouseEventArgs e ) : void |
When we get a mouse wheel event for windows other than the scrolling controller then pass on the message to the scrolling controller.
|
|
OnPaint ( PaintEventArgs e ) : void |
Call Draw() which does all the real painting
|
|
SaveSelectionInfo ( |
Save the location information for the current selection being made visible.
|
|
SelectContentsOfCell ( IVwSelection vwsel ) : void |
|
Method | Description | |
---|---|---|
DoMouseWheelVScroll ( MouseEventArgs e ) : bool | ||
DoSelectionSideEffects ( MouseEventArgs e ) : void | ||
FireSelectionChanged ( object parameter ) : bool | ||
GetCurrentTableCellInfo ( IVwSelection vwsel, int &iLevel, int &iBox, int &iTableBox, int &cTableBoxes, int &iTableLevel, int &iCellBox, int &cCellBoxes, int &iCellLevel ) : void |
Gets the row/cell information of the current selection.
|
|
GetNewSelectionObject ( int index ) : int |
Convert the new selection into a real object before making any selection. Otherwise the views code might convert it during the selection, making the selection invalid.
|
|
GetRowIndexFromSelection ( IVwSelection sel, bool fEndPoint ) : int |
Given a selection in the view, return the row index. Rarely may return -1 if unable to identify a row.
|
|
GetStringList ( |
Get from the specified node a list of strings, as used in filter bar and bulk edit bar, where the node is expected to have a [stringList] first child element which is interpreted in the context of our string table.
|
|
InitializeComponent ( ) : void |
Required method for Designer support - do not modify the contents of this method with the code editor.
|
|
LocationOfSelectedRow ( ) : |
||
MakeSelectionAt ( MouseEventArgs e ) : IVwSelection |
Make the selection that would be made by clicking at the specified mouse event, but don't install it.
|
|
RemoveRootBoxSelectionOnIdle ( object parameter ) : bool | ||
RestoreScrollPosition ( int irow ) : bool |
Called by BulkEditBar if Preview makes the highlighted row scroll off the screen. It attempts to scroll to a position such that the top of the object at index irow is m_dyTopOfScreenOffset pixels below the top of the client area (or above, if m_dyTopOfScreenOffset is negative).
|
|
SetDefaultInsertionPointInRow ( int index ) : bool |
Set an insertion point somewhere in the given row, and install the selection if it exists.
|
|
SetSelectedIndex ( int ihvo ) : void | ||
ShouldConvertDummiesInView ( ) : bool |
read configuration for the browse view to determine whether to try to convert dummy objects to real objects when as they become painted on the screen. (Default is false)
|
|
UpdateSelectedRow ( object args ) : bool |
protected AdjustScrollRange1 ( int dxdSize, int dxdPosition, int dydSize, int dydPosition ) : bool | ||
dxdSize | int | change in the horizontal size |
dxdPosition | int | horizontal position where change occurred |
dydSize | int | change in the vertical size |
dydPosition | int | vertical position where change occurred |
return | bool |
public ColumnSortedFromEnd ( int icol ) : bool | ||
icol | int | |
return | bool |
protected CreateSelectionRestorer ( ) : SIL.FieldWorks.Common.RootSites.SelectionRestorer | ||
return | SIL.FieldWorks.Common.RootSites.SelectionRestorer |
protected DoSelectAndScroll ( int hvo, int index ) : void | ||
hvo | int | The hvo. |
index | int | The index. |
return | void |
protected DoSelectionSideEffects ( IVwSelection sel ) : void | ||
sel | IVwSelection | |
return | void |
public GetCorrespondingPropertyName ( string property ) : string | ||
property | string | The property. |
return | string |
protected GetRowSelection ( int index ) : IVwSelection | ||
index | int | The index. |
return | IVwSelection |
protected HandleSelectionChange ( IVwRootBox prootb, IVwSelection vwselNew ) : void | ||
prootb | IVwRootBox | |
vwselNew | IVwSelection | |
return | void |
public Init ( XCore mediator, System configurationParameters ) : void | ||
mediator | XCore | |
configurationParameters | System | |
return | void |
public Init ( |
||
nodeSpec | The node spec. | |
hvoRoot | int | The hvo root. |
fakeFlid | int | The fake flid. |
cache | SIL.FieldWorks.FDO.FdoCache | The cache. |
mediator | XCore.Mediator | The mediator. |
bv | BrowseViewer | The bv. Also used to set SortItemProvider |
return | void |
public OnDeleteRecord ( object commandObject ) : bool | ||
commandObject | object | The command object. |
return | bool |
public OnDisplayDeleteRecord ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool | ||
commandObject | object | |
display | XCore.UIItemDisplayProperties | |
return | bool |
protected OnGotFocus ( |
||
e | ||
return | void |
protected OnKeyDown ( |
||
e | ||
return | void |
protected OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void | ||
levent | System.Windows.Forms.LayoutEventArgs | |
return | void |
protected OnMouseDown ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseUp ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseWheel ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnPaint ( PaintEventArgs e ) : void | ||
e | PaintEventArgs | |
return | void |
public OnPasteFixTssEvent ( EditingHelper sender, FwPasteFixTssEventArgs e ) : void | ||
sender | EditingHelper | |
e | FwPasteFixTssEventArgs | |
return | void |
public OnPrepareToRefresh ( object args ) : bool | ||
args | object | The args. |
return | bool |
public OnRequestDebugInfo ( object commandObj ) : bool | ||
commandObj | object | The command obj. |
return | bool |
public OnRestoreScrollPosition ( object args ) : bool | ||
args | object | |
return | bool |
public OnSaveScrollPosition ( object args ) : bool | ||
args | object | |
return | bool |
public PropChanged ( int hvo, int tag, int ivMin, int cvIns, int cvDel ) : void | ||
hvo | int | |
tag | int | |
ivMin | int | |
cvIns | int | |
cvDel | int | |
return | void |
protected SaveSelectionInfo ( |
||
rcIdeal | rectangle of selection | |
ydTop | int | current scroll position |
return | void |
protected SelectContentsOfCell ( IVwSelection vwsel ) : void | ||
vwsel | IVwSelection | |
return | void |
public SetScrollBarParameters ( |
||
scrollBar | ||
return | void |
protected SelectionHighlighting m_fSelectedRowHighlighting | ||
return | SelectionHighlighting |
protected int m_iTopOfScreenObjectForScrollPosition | ||
return | int |
protected ISortItemProvider m_sortItemProvider | ||
return | ISortItemProvider |
protected StringTable,SIL.Utils m_stringTable | ||
return | SIL.Utils.StringTable |
protected XmlBrowseViewBaseVc,SIL.FieldWorks.Common.Controls m_xbvvc | ||
return | SIL.FieldWorks.Common.Controls.XmlBrowseViewBaseVc |