Class HtmlTextExtenderBase
This is the base class for all extenders that add HtmlText and Text fields to their base query. The desired name and display name of the html-text field are passed in as constructor arguments, since specific field names are much more desirable than using prefixes and a standard name. Derived classes should implement the ExtenderBase.SetJoin method to join an TextTableInfo to the RootQuery, and set the column name and display name in their constructor.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public abstract class HtmlTextExtenderBase : TextExtenderBase, IArchiveProviderQueryMapping, IArchiveExtender, IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible
Constructors
HtmlTextExtenderBase(string, string, string, string)
Construct the object, setting the htmlText column name and display name. This makes use of the fact that the reflection-based column pickup is triggered on the first column-related request, not during construction of the base class (which would be too early anyway)
Declaration
protected HtmlTextExtenderBase(string textColumnName, string textColumnDisplayName, string htmlTextColumnName, string htmlTextColumnDisplayName)
Parameters
Type | Name | Description |
---|---|---|
string | textColumnName | Desired programmatic name of text column |
string | textColumnDisplayName | Desired display name of text column |
string | htmlTextColumnName | Desired programmatic name of htmlText column |
string | htmlTextColumnDisplayName | Desired display name of htmlText column |
Fields
_colHtmlText
This is the base class for all extenders that add HtmlText and Text fields to their base query. The desired name and display name of the html-text field are passed in as constructor arguments, since specific field names are much more desirable than using prefixes and a standard name. Derived classes should implement the ExtenderBase.SetJoin method to join an TextTableInfo to the RootQuery, and set the column name and display name in their constructor.
Declaration
protected ArchiveColumnInfo _colHtmlText
Field Value
Type | Description |
---|---|
ArchiveColumnInfo |
Methods
GetHtmlText(SoDataReader)
This is the base class for all extenders that add HtmlText and Text fields to their base query. The desired name and display name of the html-text field are passed in as constructor arguments, since specific field names are much more desirable than using prefixes and a standard name. Derived classes should implement the ExtenderBase.SetJoin method to join an TextTableInfo to the RootQuery, and set the column name and display name in their constructor.
Declaration
public ArchiveColumnData GetHtmlText(SoDataReader reader)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader |
Returns
Type | Description |
---|---|
ArchiveColumnData |
InnerModifyQuery()
Add/map return fields to the query; call SetJoin to obtain the contact table info instance from the derived class
Declaration
protected override void InnerModifyQuery()
Overrides
RequestHtmlText()
This is the base class for all extenders that add HtmlText and Text fields to their base query. The desired name and display name of the html-text field are passed in as constructor arguments, since specific field names are much more desirable than using prefixes and a standard name. Derived classes should implement the ExtenderBase.SetJoin method to join an TextTableInfo to the RootQuery, and set the column name and display name in their constructor.
Declaration
public void RequestHtmlText()
RequestHtmlTextForRestriction()
This is the base class for all extenders that add HtmlText and Text fields to their base query. The desired name and display name of the html-text field are passed in as constructor arguments, since specific field names are much more desirable than using prefixes and a standard name. Derived classes should implement the ExtenderBase.SetJoin method to join an TextTableInfo to the RootQuery, and set the column name and display name in their constructor.
Declaration
public void RequestHtmlTextForRestriction()