C# Class SIL.FieldWorks.FwCoreDlgs.PicturePropertiesDialog

Dialog for editing picture properties

Inheritance: System.Windows.Forms.Form, IFWDisposable

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
GetMultilingualCaptionValues ( IMultiAccessorBase caption ) : void	Store the results of any editing into the actual data.
Initialize ( ) : bool	Initialize the dialog (and let the user select a picture)
PicturePropertiesDialog ( SIL.FieldWorks.FDO.FdoCache cache, ICmPicture initialPicture, IHelpTopicProvider helpTopicProvider, IApp app ) : System	Initializes a new instance of the T:PicturePropertiesDialog class.
PicturePropertiesDialog ( SIL.FieldWorks.FDO.FdoCache cache, ICmPicture initialPicture, IHelpTopicProvider helpTopicProvider, IApp app, bool fAnalysis ) : System	Initializes a new instance of the T:PicturePropertiesDialog class.
SetMultilingualCaptionValues ( IMultiAccessorBase caption ) : void	Set the multilingual caption into the dialog control.
UseMultiStringCaption ( SIL.FieldWorks.FDO.FdoCache cache, int wsMagic, IVwStylesheet stylesheet ) : void	Convert the text box for the caption to a multilingual string control.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnClosed ( EventArgs e ) : void	Log a message when the dialog is closed.
OnClosing ( CancelEventArgs e ) : void	Raises the E:System.Windows.Forms.Form.Closing event.

Private Methods

Method	Description
ApplyDefaultFileLocationChoice ( ) : void	Applies the default file location choice.
ApplyFileLocationOptions ( ) : void	Called when the user clicked the OK button and the File Location Options panel is visible.
FileIsInLinkedFilesFolder ( string sFilePath ) : bool	Determines whether file is in the LinkedFiles folder.
HandleLocationCheckedChanged ( object sender, EventArgs e ) : void	Makes sure the destination text box and chooser button are disabled when the user chooses to leave the picture in its original folder.
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
IsFolderInLinkedFilesFolder ( string sFolder ) : bool	Determines whether given folder is in LinkedFiles folder.
MakeEmptyCaptionString ( ) : ITsString	Makes an empty caption string.
ShowChoosePictureDlg ( ) : DialogResult	Show the file chooser dialog for opening an image file.
UpdatePicInformation ( ) : void	Updates the information in the dialog for the current image
ValidateDestinationFolder ( string proposedDestFolder ) : bool	Validates the proposed destination folder.
lblFilename_MouseEnter ( object sender, EventArgs e ) : void
lblFilename_Paint ( object sender, PaintEventArgs e ) : void	Draw the file name with EllipsisPath trimming.
m_btnBrowseDest_Click ( object sender, EventArgs e ) : void	Handles the Click event of the m_btnBrowseDest control.
m_btnChooseFile_Click ( object sender, EventArgs e ) : void	Handle event when user clicks on button to choose an image file.
m_btnHelp_Click ( object sender, EventArgs e ) : void	Show help for this dialog
m_picPreview_ClientSizeChanged ( object sender, EventArgs e ) : void	Handles the ClientSizeChanged event of the m_picPreview control.

Method Details

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

public CheckDisposed ( ) : void
return	void

Dispose() protected method

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. ///
return	void

GetMultilingualCaptionValues() public method

Store the results of any editing into the actual data.

public GetMultilingualCaptionValues ( IMultiAccessorBase caption ) : void
caption	IMultiAccessorBase
return	void

Initialize() public method

Initialize the dialog (and let the user select a picture)

public Initialize ( ) : bool
return	bool

OnClosed() protected method

Log a message when the dialog is closed.

protected OnClosed ( EventArgs e ) : void
e	System.EventArgs
return	void

OnClosing() protected method

Raises the E:System.Windows.Forms.Form.Closing event.

protected OnClosing ( CancelEventArgs e ) : void
e	CancelEventArgs	A that /// contains the event data.
return	void

PicturePropertiesDialog() public method

Initializes a new instance of the T:PicturePropertiesDialog class.

public PicturePropertiesDialog ( SIL.FieldWorks.FDO.FdoCache cache, ICmPicture initialPicture, IHelpTopicProvider helpTopicProvider, IApp app ) : System
cache	SIL.FieldWorks.FDO.FdoCache	The FdoCache to use
initialPicture	ICmPicture	The CmPicture object to set all of the dialog /// properties to, or null to edit a new picture
helpTopicProvider	IHelpTopicProvider	typically IHelpTopicProvider.App
app	IApp	The application
return	System

PicturePropertiesDialog() public method

Initializes a new instance of the T:PicturePropertiesDialog class.

public PicturePropertiesDialog ( SIL.FieldWorks.FDO.FdoCache cache, ICmPicture initialPicture, IHelpTopicProvider helpTopicProvider, IApp app, bool fAnalysis ) : System
cache	SIL.FieldWorks.FDO.FdoCache	The FdoCache to use
initialPicture	ICmPicture	The CmPicture object to set all of the dialog /// properties to, or null to edit a new picture
helpTopicProvider	IHelpTopicProvider	typically IHelpTopicProvider.App
app	IApp	The application
fAnalysis	bool	true to use analysis writign system for caption
return	System

SetMultilingualCaptionValues() public method

Set the multilingual caption into the dialog control.

public SetMultilingualCaptionValues ( IMultiAccessorBase caption ) : void
caption	IMultiAccessorBase
return	void

UseMultiStringCaption() public method

Convert the text box for the caption to a multilingual string control.

public UseMultiStringCaption ( SIL.FieldWorks.FDO.FdoCache cache, int wsMagic, IVwStylesheet stylesheet ) : void
cache	SIL.FieldWorks.FDO.FdoCache
wsMagic	int
stylesheet	IVwStylesheet
return	void