C# Class SIL.FieldWorks.TE.TeResourceHelper

Summary description for TeResourceHelper.

Inheritance: SIL.FieldWorks.Resources.ResourceHelper

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Properties

Property	Type	Description
BiblicalTermsResourceName	string
NonEditableColor	Color
ReadOnlyTextBackgroundColor	Color

Private Properties

Property	Type	Description
InitializeComponent	void

Public Methods

Method	Description
FormatResourceString ( string stid ) : string	Return a string from a resource ID, with formatting placeholders replaced by the supplied parameters.
GetHelpString ( string stid ) : string	Return a help topic or help file path.
GetResourceString ( string stid ) : string	Return a string from a resource ID.
GetTmResourceString ( string stid ) : string	Return a string from a resource ID for a toolbar/menu item.
MakeUndoRedoLabels ( string stid, string &stUndo, string &stRedo ) : void	Function to create appropriate labels for Undo tasks, with the action names coming from the stid.
TeResourceHelper ( ) : System	Initializes a new instance of the TeResourceHelper class.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
DisposeStaticMembers ( ) : void	Dispose static member variables

Private Methods

Method	Description
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.

Method Details

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

DisposeStaticMembers() protected method

Dispose static member variables

protected DisposeStaticMembers ( ) : void
return	void

FormatResourceString() public static method

Return a string from a resource ID, with formatting placeholders replaced by the supplied parameters.

public static FormatResourceString ( string stid ) : string
stid	string	String resource id
return	string

GetHelpString() public static method

Return a help topic or help file path.

public static GetHelpString ( string stid ) : string
stid	string	String resource id
return	string

GetResourceString() public static method

Return a string from a resource ID.

public static GetResourceString ( string stid ) : string
stid	string	String resource id
return	string

GetTmResourceString() public static method

Return a string from a resource ID for a toolbar/menu item.

public static GetTmResourceString ( string stid ) : string
stid	string	String resource id
return	string

MakeUndoRedoLabels() public static method

Function to create appropriate labels for Undo tasks, with the action names coming from the stid.

public static MakeUndoRedoLabels ( string stid, string &stUndo, string &stRedo ) : void
stid	string	String resource id
stUndo	string	Returns string for Undo task
stRedo	string	Returns string for Redo task
return	void

TeResourceHelper() public method

Initializes a new instance of the TeResourceHelper class.

public TeResourceHelper ( ) : System
return	System

Property Details

BiblicalTermsResourceName public static property

public static string BiblicalTermsResourceName
return	string

NonEditableColor public static property

The background color for non-editable text

public static Color NonEditableColor
return	Color

ReadOnlyTextBackgroundColor public static property

This is a color indended to be used as a background for views that contain a mixture of read-only and editable text, with the editable text indicated by being SystemColors.Window. The initial example is TE's draft back translation in interlinear mode. The actual color used was copied from a similar view in OurWord.

public static Color ReadOnlyTextBackgroundColor
return	Color