C# Class SobekCM.Core.UI_Configuration.Citation.CitationElement

Afficher le fichier Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Свойство Type Description

Méthodes publiques

Méthode Description
Add_Option ( string Key, string Value ) : void

Add a new option to this citation element configuration

Add_Translation ( Web_Language_Enum Language, string Value ) : void

Add a new translation for the display term

CitationElement ( ) : System

Constructor for a new instance of the CitationElement class

CitationElement ( string MetadataTerm, string DisplayTerm, string SearchCode, string ItemProp ) : System

Constructor for a new instance of the CitationElement class

CitationElement ( string MetadataTerm, string DisplayTerm, string SearchCode, string ItemProp, CitationElement_OverrideDispayTerm_Enum OverrideDisplayTerm ) : System

Constructor for a new instance of the CitationElement class

ShouldSerializeItemProp ( ) : bool

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

ShouldSerializeOptions ( ) : bool

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

ShouldSerializeOverrideDisplayTerm ( ) : bool

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

ShouldSerializeSearchCode ( ) : bool

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

ShouldSerializeTranslations ( ) : bool

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

Method Details

Add_Option() public méthode

Add a new option to this citation element configuration
public Add_Option ( string Key, string Value ) : void
Key string Key for this key/value pair
Value string Value for this key/value pair
Résultat void

Add_Translation() public méthode

Add a new translation for the display term
public Add_Translation ( Web_Language_Enum Language, string Value ) : void
Language Web_Language_Enum Language in which this value is represented
Value string Value in provided language
Résultat void

CitationElement() public méthode

Constructor for a new instance of the CitationElement class
public CitationElement ( ) : System
Résultat System

CitationElement() public méthode

Constructor for a new instance of the CitationElement class
public CitationElement ( string MetadataTerm, string DisplayTerm, string SearchCode, string ItemProp ) : System
MetadataTerm string Metadata term this citation element displays (or a unique value)
DisplayTerm string Default display term for this citation element
SearchCode string SobekCM search code, if this element should be clickable /// to initiate a search within SobekCM
ItemProp string Schema.org microdata tag to include for this element
Résultat System

CitationElement() public méthode

Constructor for a new instance of the CitationElement class
public CitationElement ( string MetadataTerm, string DisplayTerm, string SearchCode, string ItemProp, CitationElement_OverrideDispayTerm_Enum OverrideDisplayTerm ) : System
MetadataTerm string Metadata term this citation element displays (or a unique value)
DisplayTerm string Default display term for this citation element
SearchCode string SobekCM search code, if this element should be clickable /// to initiate a search within SobekCM
ItemProp string Schema.org microdata tag to include for this element
OverrideDisplayTerm CitationElement_OverrideDispayTerm_Enum Flag indicatse if the basic citation section writer should override /// the display term and use some other value from within the individual item metadata
Résultat System

ShouldSerializeItemProp() public méthode

Method suppresses XML Serialization of the ItemProp property if it is empty
public ShouldSerializeItemProp ( ) : bool
Résultat bool

ShouldSerializeOptions() public méthode

Method suppresses XML Serialization of the Options property if it is empty
public ShouldSerializeOptions ( ) : bool
Résultat bool

ShouldSerializeOverrideDisplayTerm() public méthode

Method suppresses XML Serialization of the OverrideDisplayTerm property if it is empty
public ShouldSerializeOverrideDisplayTerm ( ) : bool
Résultat bool

ShouldSerializeSearchCode() public méthode

Method suppresses XML Serialization of the SearchCode property if it is empty
public ShouldSerializeSearchCode ( ) : bool
Résultat bool

ShouldSerializeTranslations() public méthode

Method suppresses XML Serialization of the Translations property if it is empty
public ShouldSerializeTranslations ( ) : bool
Résultat bool