C# Class SobekCM.Core.Configuration.QualityControl_Division_Config

Configuration information for a single possible division type
Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property Type Description
Convert_String_To_XML_Safe string
Write_Translations void

Public Methods

Method Description
Add_Translation ( Web_Language_Enum Language, string Translation ) : void

Add a translated type for this division

Get_Translation ( Web_Language_Enum Language, bool useDefaultIfNotPresent ) : string

Get the type translated into the language specified

QualityControl_Division_Config ( ) : System

Constructor for a new instance of the QualityControl_Division_Config class

QualityControl_Division_Config ( int ID, string TypeName, bool isActive, bool isNameable ) : System

Constructor for a new instance of the QualityControl_Division_Config class

QualityControl_Division_Config ( int ID, string TypeName, bool isActive, bool isNameable, string BaseTypeName ) : System

Constructor for a new instance of the QualityControl_Division_Config class

ShouldSerializeBaseTypeName ( ) : bool

Method suppresses XML Serialization of the BaseTypeName property if it is empty

ShouldSerializeTypeTranslations ( ) : bool

Method suppresses XML Serialization of the TypeTranslations collection if it is empty

Private Methods

Method Description
Convert_String_To_XML_Safe ( string element ) : string

Converts a basic string into an XML-safe string

Write_Translations ( StreamWriter writer ) : void

Method Details

Add_Translation() public method

Add a translated type for this division
public Add_Translation ( Web_Language_Enum Language, string Translation ) : void
Language Web_Language_Enum Language for this translation
Translation string Translation of the type of this division
return void

Get_Translation() public method

Get the type translated into the language specified
public Get_Translation ( Web_Language_Enum Language, bool useDefaultIfNotPresent ) : string
Language Web_Language_Enum UI language
useDefaultIfNotPresent bool Flag determines if the default type should be returned /// if the specified language does not exist
return string

QualityControl_Division_Config() public method

Constructor for a new instance of the QualityControl_Division_Config class
public QualityControl_Division_Config ( ) : System
return System

QualityControl_Division_Config() public method

Constructor for a new instance of the QualityControl_Division_Config class
public QualityControl_Division_Config ( int ID, string TypeName, bool isActive, bool isNameable ) : System
ID int Key for this division configuration information
TypeName string Name of this type, which the user selects. This is also the default name, if /// a translation for this name is not provided in a requested language
isActive bool Flag indicates if this division is currently active
isNameable bool Flag indicates if the user will be asked for a name when this division is chosen
return System

QualityControl_Division_Config() public method

Constructor for a new instance of the QualityControl_Division_Config class
public QualityControl_Division_Config ( int ID, string TypeName, bool isActive, bool isNameable, string BaseTypeName ) : System
ID int Key for this division configuration information
TypeName string Name of this type, which the user selects. This is also the default name, if /// a translation for this name is not provided in a requested language
isActive bool Flag indicates if this division is currently active
isNameable bool Flag indicates if the user will be asked for a name when this division is chosen
BaseTypeName string If this is set, then the typename is actually used as the division label /// and this is used as the type within the METS structure map
return System

ShouldSerializeBaseTypeName() public method

Method suppresses XML Serialization of the BaseTypeName property if it is empty
public ShouldSerializeBaseTypeName ( ) : bool
return bool

ShouldSerializeTypeTranslations() public method

Method suppresses XML Serialization of the TypeTranslations collection if it is empty
public ShouldSerializeTypeTranslations ( ) : bool
return bool