C# 클래스 SIL.FieldWorks.XWorks.XmlDocView

XmlDocView is a view that shows a complete list as a single view. A RecordClerk class does most of the work of managing the list and current object. list management and navigation is entirely(?) handled by the RecordClerk. The actual view of each object is specified by a child node of the view node. This specifies how to display an individual list item.
상속: SIL.FieldWorks.XWorks.XWorksViewBase
파일 보기 프로젝트 열기: sillsdev/FieldWorks 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
m_configObjectName string
m_currentIndex int
m_currentObject ICmObject
m_hvoOwner int
m_mainView SIL.FieldWorks.Common.Controls.XmlSeqView

Private Properties

프로퍼티 타입 설명
AdjustedClerkIndex int
BaseLayoutName string
DisposeTooltip void
ExtractLayoutsFromLayoutTypeList string>>.IEnumerable
FindViewNameInList string
GatherBuiltInAndUserLayouts string>>.IEnumerable
GetBuiltInLayouts string>>.IEnumerable
GetPublicationName string
GetSafeWsName string
GetSelectedConfigView string
GetSelectedPublication string
GetTarget ICmObject
GetUserDefinedDictLayouts string>>.IEnumerable
GetWidthOfStringInPixels int
GiveSimpleWarning void
InitializeComponent void
IsCurrentConfigViewChanged bool
IsCurrentPublicationChanged bool
IsCurrentReversalWsChanged bool
IsDesiredPublication bool
IsObjectVisible bool
MakePublicationTitlePart string
NoReasonToChangeTitle bool
OnMouseClick void
ResetSpacer void
RunConfigureDialog void
SelectAndScrollToCurrentRecord void
SetConfigViewTitle void
SubitemClicked ICmObject
SubitemClicked ICmObject
TrimToMaxPixelWidth string
TryToJumpToSelection void

공개 메소드들

메소드 설명
GetPubDecorator ( ) : DictionaryPublicationDecorator
Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
OnCheckJump ( object argument ) : bool

Check to see if the user needs to be alerted that JumpToRecord is not possible.

OnClerkOwningObjChanged ( object sender ) : bool
OnConfigureXmlDocView ( object commandObject ) : bool

Launch the configure dialog.

OnDeleteRecord ( object commandObject ) : bool

If this gets called (which it never should), just say we did it, unless we are in the context of reversal entries. In the case of reversal entries, we say we did not do it, so the record clerk deals with it.

OnDisplayConfigureXmlDocView ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

The configure dialog may be launched any time this tool is active. Its name is derived from the name of the tool.

OnDisplayDeleteRecord ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

see if it makes sense to provide the "delete record" command now. Currently we don't support this in document view, except for reversal entries. If we decide to support it, we will need to do additional work (cf LT-1222) to ensure that (a) The clerk's idea of the current entry corresponds to where the selection is (b) After deleting it, the clerk's list gets updated. The former is not happening because we haven't written a SelectionChange method to notice the selection in the view and change the clerk to match. Not sure why the clerk's list isn't being updated...it may be only a problem for homographs.

OnDisplayFindAndReplaceText ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

Enables the command that just does Find, without Replace.

OnDisplayLayouts ( object parameter, XCore.UIListDisplayProperties &display ) : bool

Populate the list of layout views for the second dictionary titlebar menu.

OnDisplayPublications ( object parameter, XCore.UIListDisplayProperties &display ) : bool

Populate the list of publications for the first dictionary titlebar menu.

OnDisplayReplaceText ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool

Enables the command that just does Find, without Replace.

OnDisplayShowAllEntries ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
OnFindAndReplaceText ( object argument ) : bool

Implements the command that just does Find, without Replace.

OnPropertyChanged ( string name ) : void

Receives the broadcast message "PropertyChanged"

OnRecordNavigation ( object argument ) : bool
OnReplaceText ( object argument ) : bool

Implements the command that just does Find, without Replace.

OnSelectionChanged ( object sender, SIL.FieldWorks.Common.Utils.FwObjectSelectionEventArgs e ) : void

invoked when our XmlDocView selection changes.

OnShowAllEntries ( object args ) : bool
PostLayoutInit ( ) : void

We wait until containing controls are laid out to try to scroll our selection into view, because it depends somewhat on the window being the true size.

PrintFromDetail ( PrintDocument pd, int recordHvo ) : void

Pass command (from RecordEditView) on to printing view.

XmlDocView ( ) : System

Initializes a new instance of the ViewManager class.

보호된 메소드들

메소드 설명
Dispose ( bool disposing ) : void

Clean up any resources being used.

DisposeContextMenu ( object sender, EventArgs e ) : void
GetMessageAdditionalTargets ( List collector ) : void

subclasses should override if they have more targets

InitBase ( XCore.Mediator mediator, XmlNode configurationParameters ) : void

Initialize this as an IxCoreColleague

subclasses must call this from their Init. This was done, rather than providing an Init() here in the normal way, to drive home the point that the subclass must set m_fullyInitialized to true when it is fully initialized.

OnMouseLeave ( EventArgs e ) : void
OnMouseMove ( MouseEventArgs e ) : void
OnPaint ( PaintEventArgs e ) : void

Ensure that we have the current record selected and visible in the window. See LT-9109.

OnParentChanged ( EventArgs e ) : void
OnSizeChanged ( EventArgs e ) : void
ReadParameters ( ) : void

Read in the parameters to determine which sequence/collection we are editing.

RunConfigureDialogAt ( object sender, EventArgs e ) : void
SetInfoBarText ( ) : void
SetupDataContext ( ) : void
SetupStylesheet ( ) : void
ShowRecord ( ) : void
m_contextMenu_Closed ( object sender, System.Windows.Forms.ToolStripDropDownClosedEventArgs e ) : void
m_mainView_MouseClick ( object sender, MouseEventArgs e ) : void
m_mainView_MouseLeave ( object sender, EventArgs e ) : void
m_mainView_MouseMove ( object sender, MouseEventArgs e ) : void

비공개 메소드들

메소드 설명
AdjustedClerkIndex ( ) : int

By default this returns Clerk.CurrentIndex. However, when we are using a decorator for the view, we may need to adjust the index.

BaseLayoutName ( string name ) : string
DisposeTooltip ( ) : void
ExtractLayoutsFromLayoutTypeList ( IEnumerable layouts ) : string>>.IEnumerable
FindViewNameInList ( string>.IEnumerable layoutList ) : string
GatherBuiltInAndUserLayouts ( ) : string>>.IEnumerable
GetBuiltInLayouts ( XmlNode configNode ) : string>>.IEnumerable
GetPublicationName ( ) : string
GetSafeWsName ( ) : string
GetSelectedConfigView ( ) : string
GetSelectedPublication ( ) : string
GetTarget ( ICmObject obj, int clsid ) : ICmObject
GetUserDefinedDictLayouts ( IEnumerable builtInLayouts, IEnumerable layouts ) : string>>.IEnumerable
GetWidthOfStringInPixels ( string sInput ) : int
GiveSimpleWarning ( ExclusionReasonCode xrc ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

IsCurrentConfigViewChanged ( ) : bool
IsCurrentPublicationChanged ( ) : bool
IsCurrentReversalWsChanged ( ) : bool
IsDesiredPublication ( ICmPossibility item, string name ) : bool
IsObjectVisible ( int hvoTarget, ExclusionReasonCode &xrc ) : bool
MakePublicationTitlePart ( string titleStr ) : string
NoReasonToChangeTitle ( string context ) : bool
OnMouseClick ( MouseEventArgs e ) : void
ResetSpacer ( int spacerWidth, string activeLayoutName ) : void
RunConfigureDialog ( string nodePath ) : void
SelectAndScrollToCurrentRecord ( ) : void
SetConfigViewTitle ( ) : void
SubitemClicked ( Point where, int clsid ) : ICmObject

Return the most specific object identified by a click at the specified position. An object is considered indicated if it is or has an owner of the specified class. The object must be different from the outermost indicated object in the selection.

SubitemClicked ( Point where, int clsid, SimpleRootSite view, SIL.FieldWorks.FDO.FdoCache cache, ISortItemProvider sortItemProvider, IPreferedTargetAdjuster adjuster ) : ICmObject

Return an item of the specified class that is indicated by a click at the specified position, but only if it is part of a different object also of that class.

TrimToMaxPixelWidth ( int pixelWidthAllowed, string sToTrim ) : string
TryToJumpToSelection ( Point where ) : void

메소드 상세

Dispose() 보호된 메소드

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged /// resources; false to release only unmanaged resources. ///
리턴 void

DisposeContextMenu() 보호된 메소드

protected DisposeContextMenu ( object sender, EventArgs e ) : void
sender object
e System.EventArgs
리턴 void

GetMessageAdditionalTargets() 보호된 메소드

subclasses should override if they have more targets
protected GetMessageAdditionalTargets ( List collector ) : void
collector List
리턴 void

GetPubDecorator() 공개 메소드

public GetPubDecorator ( ) : DictionaryPublicationDecorator
리턴 DictionaryPublicationDecorator

Init() 공개 메소드

public Init ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator XCore.Mediator
configurationParameters System.Xml.XmlNode
리턴 void

InitBase() 보호된 메소드

Initialize this as an IxCoreColleague
subclasses must call this from their Init. This was done, rather than providing an Init() here in the normal way, to drive home the point that the subclass must set m_fullyInitialized to true when it is fully initialized.
protected InitBase ( XCore.Mediator mediator, XmlNode configurationParameters ) : void
mediator XCore.Mediator
configurationParameters System.Xml.XmlNode
리턴 void

OnCheckJump() 공개 메소드

Check to see if the user needs to be alerted that JumpToRecord is not possible.
public OnCheckJump ( object argument ) : bool
argument object the hvo of the record
리턴 bool

OnClerkOwningObjChanged() 공개 메소드

public OnClerkOwningObjChanged ( object sender ) : bool
sender object
리턴 bool

OnConfigureXmlDocView() 공개 메소드

Launch the configure dialog.
public OnConfigureXmlDocView ( object commandObject ) : bool
commandObject object
리턴 bool

OnDeleteRecord() 공개 메소드

If this gets called (which it never should), just say we did it, unless we are in the context of reversal entries. In the case of reversal entries, we say we did not do it, so the record clerk deals with it.
public OnDeleteRecord ( object commandObject ) : bool
commandObject object
리턴 bool

OnDisplayConfigureXmlDocView() 공개 메소드

The configure dialog may be launched any time this tool is active. Its name is derived from the name of the tool.
public OnDisplayConfigureXmlDocView ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
리턴 bool

OnDisplayDeleteRecord() 공개 메소드

see if it makes sense to provide the "delete record" command now. Currently we don't support this in document view, except for reversal entries. If we decide to support it, we will need to do additional work (cf LT-1222) to ensure that (a) The clerk's idea of the current entry corresponds to where the selection is (b) After deleting it, the clerk's list gets updated. The former is not happening because we haven't written a SelectionChange method to notice the selection in the view and change the clerk to match. Not sure why the clerk's list isn't being updated...it may be only a problem for homographs.
public OnDisplayDeleteRecord ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
리턴 bool

OnDisplayFindAndReplaceText() 공개 메소드

Enables the command that just does Find, without Replace.
public OnDisplayFindAndReplaceText ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
리턴 bool

OnDisplayLayouts() 공개 메소드

Populate the list of layout views for the second dictionary titlebar menu.
public OnDisplayLayouts ( object parameter, XCore.UIListDisplayProperties &display ) : bool
parameter object The parameter.
display XCore.UIListDisplayProperties The display.
리턴 bool

OnDisplayPublications() 공개 메소드

Populate the list of publications for the first dictionary titlebar menu.
public OnDisplayPublications ( object parameter, XCore.UIListDisplayProperties &display ) : bool
parameter object The parameter.
display XCore.UIListDisplayProperties The display.
리턴 bool

OnDisplayReplaceText() 공개 메소드

Enables the command that just does Find, without Replace.
public OnDisplayReplaceText ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
리턴 bool

OnDisplayShowAllEntries() 공개 메소드

public OnDisplayShowAllEntries ( object commandObject, XCore.UIItemDisplayProperties &display ) : bool
commandObject object
display XCore.UIItemDisplayProperties
리턴 bool

OnFindAndReplaceText() 공개 메소드

Implements the command that just does Find, without Replace.
public OnFindAndReplaceText ( object argument ) : bool
argument object
리턴 bool

OnMouseLeave() 보호된 메소드

protected OnMouseLeave ( EventArgs e ) : void
e System.EventArgs
리턴 void

OnMouseMove() 보호된 메소드

protected OnMouseMove ( MouseEventArgs e ) : void
e MouseEventArgs
리턴 void

OnPaint() 보호된 메소드

Ensure that we have the current record selected and visible in the window. See LT-9109.
protected OnPaint ( PaintEventArgs e ) : void
e PaintEventArgs
리턴 void

OnParentChanged() 보호된 메소드

protected OnParentChanged ( EventArgs e ) : void
e System.EventArgs
리턴 void

OnPropertyChanged() 공개 메소드

Receives the broadcast message "PropertyChanged"
public OnPropertyChanged ( string name ) : void
name string
리턴 void

OnRecordNavigation() 공개 메소드

public OnRecordNavigation ( object argument ) : bool
argument object
리턴 bool

OnReplaceText() 공개 메소드

Implements the command that just does Find, without Replace.
public OnReplaceText ( object argument ) : bool
argument object
리턴 bool

OnSelectionChanged() 공개 메소드

invoked when our XmlDocView selection changes.
public OnSelectionChanged ( object sender, SIL.FieldWorks.Common.Utils.FwObjectSelectionEventArgs e ) : void
sender object unused
e SIL.FieldWorks.Common.Utils.FwObjectSelectionEventArgs the event arguments
리턴 void

OnShowAllEntries() 공개 메소드

public OnShowAllEntries ( object args ) : bool
args object
리턴 bool

OnSizeChanged() 보호된 메소드

protected OnSizeChanged ( EventArgs e ) : void
e System.EventArgs
리턴 void

PostLayoutInit() 공개 메소드

We wait until containing controls are laid out to try to scroll our selection into view, because it depends somewhat on the window being the true size.
public PostLayoutInit ( ) : void
리턴 void

PrintFromDetail() 공개 메소드

Pass command (from RecordEditView) on to printing view.
public PrintFromDetail ( PrintDocument pd, int recordHvo ) : void
pd PrintDocument PrintDocument
recordHvo int
리턴 void

ReadParameters() 보호된 메소드

Read in the parameters to determine which sequence/collection we are editing.
protected ReadParameters ( ) : void
리턴 void

RunConfigureDialogAt() 보호된 메소드

protected RunConfigureDialogAt ( object sender, EventArgs e ) : void
sender object
e System.EventArgs
리턴 void

SetInfoBarText() 보호된 메소드

protected SetInfoBarText ( ) : void
리턴 void

SetupDataContext() 보호된 메소드

protected SetupDataContext ( ) : void
리턴 void

SetupStylesheet() 보호된 메소드

protected SetupStylesheet ( ) : void
리턴 void

ShowRecord() 보호된 메소드

protected ShowRecord ( ) : void
리턴 void

XmlDocView() 공개 메소드

Initializes a new instance of the ViewManager class.
public XmlDocView ( ) : System
리턴 System

m_contextMenu_Closed() 보호된 메소드

protected m_contextMenu_Closed ( object sender, System.Windows.Forms.ToolStripDropDownClosedEventArgs e ) : void
sender object
e System.Windows.Forms.ToolStripDropDownClosedEventArgs
리턴 void

m_mainView_MouseClick() 보호된 메소드

protected m_mainView_MouseClick ( object sender, MouseEventArgs e ) : void
sender object
e MouseEventArgs
리턴 void

m_mainView_MouseLeave() 보호된 메소드

protected m_mainView_MouseLeave ( object sender, EventArgs e ) : void
sender object
e System.EventArgs
리턴 void

m_mainView_MouseMove() 보호된 메소드

protected m_mainView_MouseMove ( object sender, MouseEventArgs e ) : void
sender object
e MouseEventArgs
리턴 void

프로퍼티 상세

m_configObjectName 보호되어 있는 프로퍼티

protected string m_configObjectName
리턴 string

m_currentIndex 보호되어 있는 프로퍼티

protected int m_currentIndex
리턴 int

m_currentObject 보호되어 있는 프로퍼티

Object currently being edited.
protected ICmObject m_currentObject
리턴 ICmObject

m_hvoOwner 보호되어 있는 프로퍼티

protected int m_hvoOwner
리턴 int

m_mainView 보호되어 있는 프로퍼티

protected XmlSeqView,SIL.FieldWorks.Common.Controls m_mainView
리턴 SIL.FieldWorks.Common.Controls.XmlSeqView