Class CPAdminUIBaseClass
- Namespace
- Contensive.BaseClasses
- Assembly
- CPBase.dll
Methods to create a uniform admin UI interface
public abstract class CPAdminUIBaseClass
- Inheritance
-
CPAdminUIBaseClass
- Inherited Members
Methods
CreateLayoutBuilder()
Create a new layout builder for constructing admin UI pages.
public abstract LayoutBuilderBaseClass CreateLayoutBuilder()
Returns
CreateLayoutBuilderList()
Create a list layout builder for displaying tabular data with filters.
public abstract LayoutBuilderListBaseClass CreateLayoutBuilderList()
Returns
CreateLayoutBuilderNameValue()
Create a name-value layout builder for displaying label and value pairs.
public abstract LayoutBuilderNameValueBaseClass CreateLayoutBuilderNameValue()
Returns
CreateLayoutBuilderTabbedBody()
Create a tabbed body layout builder for organizing content into tabs.
public abstract LayoutBuilderTabbedBodyBaseClass CreateLayoutBuilderTabbedBody()
Returns
CreateLayoutBuilderTwoColumnLeft()
Create a two-column layout builder with the narrow column on the left.
public abstract LayoutBuilderTwoColumnLeftBaseClass CreateLayoutBuilderTwoColumnLeft()
Returns
CreateLayoutBuilderTwoColumnRight()
Create a two-column layout builder with the narrow column on the right.
public abstract LayoutBuilderTwoColumnRightBaseClass CreateLayoutBuilderTwoColumnRight()
Returns
EndpointContainsPortal()
Portal features should only be run from with the c5 adminui portal. If not, redirect to the portal with this feature set. return false if endpoint does not include the portalframework guid. use for 1-line validation check
public abstract bool EndpointContainsPortal()
Returns
GetBooleanEditor(string, bool)
Create an input for a boolean field type
public abstract string GetBooleanEditor(string htmlName, bool htmlValue)
Parameters
Returns
GetBooleanEditor(string, bool, string)
Create an input for a boolean field type
public abstract string GetBooleanEditor(string htmlName, bool htmlValue, string htmlId)
Parameters
Returns
GetBooleanEditor(string, bool, string, bool)
Create an input for a boolean field type
public abstract string GetBooleanEditor(string htmlName, bool htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetBooleanEditor(string, bool, string, bool, bool)
Create an input for a boolean field type
public abstract string GetBooleanEditor(string htmlName, bool htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetCurrencyEditor(string, double?)
Create an input for a boolean field type
public abstract string GetCurrencyEditor(string htmlName, double? htmlValue)
Parameters
Returns
GetCurrencyEditor(string, double?, string)
Create an input for a boolean field type
public abstract string GetCurrencyEditor(string htmlName, double? htmlValue, string htmlId)
Parameters
Returns
GetCurrencyEditor(string, double?, string, bool)
Create an input for a boolean field type
public abstract string GetCurrencyEditor(string htmlName, double? htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetCurrencyEditor(string, double?, string, bool, bool)
Create an input for a boolean field type
public abstract string GetCurrencyEditor(string htmlName, double? htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetDateEditor(string, DateTime?)
Create an input for a date field type
public abstract string GetDateEditor(string htmlName, DateTime? htmlValue)
Parameters
Returns
GetDateEditor(string, DateTime?, string)
Create an input for a date field type
public abstract string GetDateEditor(string htmlName, DateTime? htmlValue, string htmlId)
Parameters
Returns
GetDateEditor(string, DateTime?, string, bool)
Create an input for a date field type
public abstract string GetDateEditor(string htmlName, DateTime? htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetDateEditor(string, DateTime?, string, bool, bool)
Create an input for a date field type
public abstract string GetDateEditor(string htmlName, DateTime? htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetDateTimeEditor(string, DateTime?)
Create an input for a datetime field type
public abstract string GetDateTimeEditor(string htmlName, DateTime? htmlValue)
Parameters
Returns
GetDateTimeEditor(string, DateTime?, string)
Create an input for a datetime field type
public abstract string GetDateTimeEditor(string htmlName, DateTime? htmlValue, string htmlId)
Parameters
Returns
GetDateTimeEditor(string, DateTime?, string, bool)
Create an input for a datetime field type
public abstract string GetDateTimeEditor(string htmlName, DateTime? htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetDateTimeEditor(string, DateTime?, string, bool, bool)
Create an input for a datetime field type
public abstract string GetDateTimeEditor(string htmlName, DateTime? htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetEditRow(string, string)
Create an html row that includes a caption, editor and optional help content
public abstract string GetEditRow(string caption, string editor)
Parameters
Returns
GetEditRow(string, string, string)
Create an html row that includes a caption, editor and optional help content
public abstract string GetEditRow(string caption, string editor, string help)
Parameters
Returns
GetEditRow(string, string, string, string)
Create an html row that includes a caption, editor and optional help content
public abstract string GetEditRow(string caption, string editor, string help, string htmlId)
Parameters
Returns
GetEditRow(string, string, string, string, bool)
Create an html row that includes a caption, editor and optional help content
public abstract string GetEditRow(string caption, string editor, string help, string htmlId, bool required)
Parameters
Returns
GetEditRow(string, string, string, string, bool, bool)
Create an html row that includes a caption, editor and optional help content
public abstract string GetEditRow(string caption, string editor, string help, string htmlId, bool required, bool blockBottomRule)
Parameters
Returns
GetFileEditor(string)
Create an input for a datetime field type
public abstract string GetFileEditor(string htmlName)
Parameters
htmlNamestring
Returns
GetFileEditor(string, string)
Create an input for a datetime field type
public abstract string GetFileEditor(string htmlName, string currentPathFilename)
Parameters
Returns
GetFileEditor(string, string, string)
Create an input for a datetime field type
public abstract string GetFileEditor(string htmlName, string currentPathFilename, string htmlId)
Parameters
Returns
GetFileEditor(string, string, string, bool)
Create an input for a datetime field type
public abstract string GetFileEditor(string htmlName, string currentPathFilename, string htmlId, bool readOnly)
Parameters
Returns
GetFileEditor(string, string, string, bool, bool)
Create an input for a datetime field type
public abstract string GetFileEditor(string htmlName, string currentPathFilename, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetHtmlCodeEditor(string, string)
Create an input for a htmlcode field type
public abstract string GetHtmlCodeEditor(string htmlName, string htmlValue)
Parameters
Returns
GetHtmlCodeEditor(string, string, string)
Create an input for a htmlcode field type
public abstract string GetHtmlCodeEditor(string htmlName, string htmlValue, string htmlId)
Parameters
Returns
GetHtmlCodeEditor(string, string, string, bool)
Create an input for a htmlcode field type
public abstract string GetHtmlCodeEditor(string htmlName, string htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetHtmlCodeEditor(string, string, string, bool, bool)
Create an input for a htmlcode field type
public abstract string GetHtmlCodeEditor(string htmlName, string htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetHtmlEditor(string, string)
Create an input for a html field type
public abstract string GetHtmlEditor(string htmlName, string htmlValue)
Parameters
Returns
GetHtmlEditor(string, string, string)
Create an input for a html field type
public abstract string GetHtmlEditor(string htmlName, string htmlValue, string htmlId)
Parameters
Returns
GetHtmlEditor(string, string, string, bool)
Create an input for a html field type
public abstract string GetHtmlEditor(string htmlName, string htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetHtmlEditor(string, string, string, bool, bool)
Create an input for a html field type
public abstract string GetHtmlEditor(string htmlName, string htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetImageEditor(string, string)
Create an input for a html field type
public abstract string GetImageEditor(string htmlName, string currentPathFilename)
Parameters
Returns
GetImageEditor(string, string, string)
Create an input for a html field type
public abstract string GetImageEditor(string htmlName, string currentPathFilename, string htmlId)
Parameters
Returns
GetImageEditor(string, string, string, bool)
Create an input for a html field type
public abstract string GetImageEditor(string htmlName, string currentPathFilename, string htmlId, bool readOnly)
Parameters
Returns
GetImageEditor(string, string, string, bool, bool)
Create an input for a html field type
public abstract string GetImageEditor(string htmlName, string currentPathFilename, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetIntegerEditor(string, int?)
Create an input for an integer field type
public abstract string GetIntegerEditor(string htmlName, int? htmlValue)
Parameters
Returns
GetIntegerEditor(string, int?, string)
Create an input for an integer field type
public abstract string GetIntegerEditor(string htmlName, int? htmlValue, string htmlId)
Parameters
Returns
GetIntegerEditor(string, int?, string, bool)
Create an input for an integer field type
public abstract string GetIntegerEditor(string htmlName, int? htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetIntegerEditor(string, int?, string, bool, bool)
Create an input for an integer field type
public abstract string GetIntegerEditor(string htmlName, int? htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetLinkEditor(string, int?)
Create an input for an integer field type
public abstract string GetLinkEditor(string htmlName, int? htmlValue)
Parameters
Returns
GetLinkEditor(string, int?, string)
Create an input for an integer field type
public abstract string GetLinkEditor(string htmlName, int? htmlValue, string htmlId)
Parameters
Returns
GetLinkEditor(string, int?, string, bool)
Create an input for an integer field type
public abstract string GetLinkEditor(string htmlName, int? htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetLinkEditor(string, int?, string, bool, bool)
Create an input for an integer field type
public abstract string GetLinkEditor(string htmlName, int? htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetLongTextEditor(string, string)
Create an input for all text field types
public abstract string GetLongTextEditor(string htmlName, string htmlValue)
Parameters
Returns
GetLongTextEditor(string, string, string)
Create an input for all text field types
public abstract string GetLongTextEditor(string htmlName, string htmlValue, string htmlId)
Parameters
Returns
GetLongTextEditor(string, string, string, bool)
Create an input for all text field types
public abstract string GetLongTextEditor(string htmlName, string htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetLongTextEditor(string, string, string, bool, bool)
Create an input for all text field types
public abstract string GetLongTextEditor(string htmlName, string htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetLookupContentEditor(string, int)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, int lookupContentId)
Parameters
Returns
GetLookupContentEditor(string, int, int)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, int lookupContentId, int lookupRecordId)
Parameters
Returns
GetLookupContentEditor(string, int, int, string)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, int lookupContentId, int lookupRecordId, string htmlId)
Parameters
Returns
GetLookupContentEditor(string, int, int, string, bool)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, int lookupContentId, int lookupRecordId, string htmlId, bool readOnly)
Parameters
Returns
GetLookupContentEditor(string, int, int, string, bool, bool)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, int lookupContentId, int lookupRecordId, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetLookupContentEditor(string, int, int, string, bool, bool, string)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, int lookupContentId, int lookupRecordId, string htmlId, bool readOnly, bool required, string sqlFilter)
Parameters
htmlNamestringlookupContentIdintlookupRecordIdinthtmlIdstringreadOnlyboolrequiredboolsqlFilterstring
Returns
GetLookupContentEditor(string, string)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, string lookupContentName)
Parameters
Returns
GetLookupContentEditor(string, string, int)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, string lookupContentName, int lookupRecordId)
Parameters
Returns
GetLookupContentEditor(string, string, int, string)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, string lookupContentName, int lookupRecordId, string htmlId)
Parameters
Returns
GetLookupContentEditor(string, string, int, string, bool)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, string lookupContentName, int lookupRecordId, string htmlId, bool readOnly)
Parameters
Returns
GetLookupContentEditor(string, string, int, string, bool, bool)
Create an input for a lookup content field type
public abstract string GetLookupContentEditor(string htmlName, string lookupContentName, int lookupRecordId, string htmlId, bool readOnly, bool required)
Parameters
htmlNamestringlookupContentNamestringlookupRecordIdinthtmlIdstringreadOnlyboolrequiredbool
Returns
GetLookupContentEditor(string, string, int, string, bool, bool, string)
Create a lookup into content
public abstract string GetLookupContentEditor(string htmlName, string lookupContentName, int lookupRecordId, string htmlId, bool readOnly, bool required, string sqlFilter)
Parameters
htmlNamestringlookupContentNamestringlookupRecordIdinthtmlIdstringreadOnlyboolrequiredboolsqlFilterstring
Returns
GetLookupListEditor(string, List<string>)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList)
Parameters
Returns
GetLookupListEditor(string, List<string>, int)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, int lookupListIndex)
Parameters
Returns
GetLookupListEditor(string, List<string>, int, string)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, int lookupListIndex, string htmlId)
Parameters
Returns
GetLookupListEditor(string, List<string>, int, string, bool)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, int lookupListIndex, string htmlId, bool readOnly)
Parameters
Returns
GetLookupListEditor(string, List<string>, int, string, bool, bool)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, int lookupListIndex, string htmlId, bool readOnly, bool required)
Parameters
htmlNamestringlookupListList<string>lookupListIndexinthtmlIdstringreadOnlyboolrequiredbool
Returns
GetLookupListEditor(string, List<string>, string)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, string lookupListName)
Parameters
Returns
GetLookupListEditor(string, List<string>, string, string)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, string lookupListName, string htmlId)
Parameters
Returns
GetLookupListEditor(string, List<string>, string, string, bool)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, string lookupListName, string htmlId, bool readOnly)
Parameters
Returns
GetLookupListEditor(string, List<string>, string, string, bool, bool)
Create an input for a lookup list content field type
public abstract string GetLookupListEditor(string htmlName, List<string> lookupList, string lookupListName, string htmlId, bool readOnly, bool required)
Parameters
htmlNamestringlookupListList<string>lookupListNamestringhtmlIdstringreadOnlyboolrequiredbool
Returns
GetMemberSelectEditor(string, int, int)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, int groupId)
Parameters
Returns
GetMemberSelectEditor(string, int, int, string)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, int groupId, string htmlId)
Parameters
Returns
GetMemberSelectEditor(string, int, int, string, bool)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, int groupId, string htmlId, bool readOnly)
Parameters
Returns
GetMemberSelectEditor(string, int, int, string, bool, bool)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, int groupId, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetMemberSelectEditor(string, int, string)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, string groupGuid)
Parameters
Returns
GetMemberSelectEditor(string, int, string, string)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, string groupGuid, string htmlId)
Parameters
Returns
GetMemberSelectEditor(string, int, string, string, bool)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, string groupGuid, string htmlId, bool readOnly)
Parameters
Returns
GetMemberSelectEditor(string, int, string, string, bool, bool)
Create an input for a member select content field type
public abstract string GetMemberSelectEditor(string htmlName, int lookupPersonId, string groupGuid, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetNumberEditor(string, double?)
Create an input for a number field type
public abstract string GetNumberEditor(string htmlName, double? htmlValue)
Parameters
Returns
GetNumberEditor(string, double?, string)
Create an input for a number field type
public abstract string GetNumberEditor(string htmlName, double? htmlValue, string htmlId)
Parameters
Returns
GetNumberEditor(string, double?, string, bool)
Create an input for a number field type
public abstract string GetNumberEditor(string htmlName, double? htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetNumberEditor(string, double?, string, bool, bool)
Create an input for a number field type
public abstract string GetNumberEditor(string htmlName, double? htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetPasswordEditor(string, string)
Create an input for all text field types
public abstract string GetPasswordEditor(string htmlName, string htmlValue)
Parameters
Returns
GetPasswordEditor(string, string, string)
Create an input for all text field types
public abstract string GetPasswordEditor(string htmlName, string htmlValue, string htmlId)
Parameters
Returns
GetPasswordEditor(string, string, string, bool)
Create an input for all text field types
public abstract string GetPasswordEditor(string htmlName, string htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetPasswordEditor(string, string, string, bool, bool)
Create an input for all text field types
public abstract string GetPasswordEditor(string htmlName, string htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetPortalFeatureLink(string, string)
return the link to the admin site portal feature
public abstract string GetPortalFeatureLink(string portalGuid, string portalFeatureGuid)
Parameters
Returns
GetPortalHtml(string)
Return the html for an admin portal identified by its guid.
public abstract string GetPortalHtml(string portalGuid)
Parameters
portalGuidstring
Returns
GetSelectorStringEditor(string, string, string)
Create an input for all text field types
public abstract string GetSelectorStringEditor(string htmlName, string htmlValue, string selectorString)
Parameters
Returns
GetSelectorStringEditor(string, string, string, string)
Create an input for all text field types
public abstract string GetSelectorStringEditor(string htmlName, string htmlValue, string selectorString, string htmlId)
Parameters
Returns
GetSelectorStringEditor(string, string, string, string, bool)
Create an input for all text field types
public abstract string GetSelectorStringEditor(string htmlName, string htmlValue, string selectorString, string htmlId, bool readOnly)
Parameters
Returns
GetSelectorStringEditor(string, string, string, string, bool, bool)
Create an input for all text field types
public abstract string GetSelectorStringEditor(string htmlName, string htmlValue, string selectorString, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetTextEditor(string, string)
Create an input for all text field types
public abstract string GetTextEditor(string htmlName, string htmlValue)
Parameters
Returns
GetTextEditor(string, string, string)
Create an input for all text field types
public abstract string GetTextEditor(string htmlName, string htmlValue, string htmlId)
Parameters
Returns
GetTextEditor(string, string, string, bool)
Create an input for all text field types
public abstract string GetTextEditor(string htmlName, string htmlValue, string htmlId, bool readOnly)
Parameters
Returns
GetTextEditor(string, string, string, bool, bool)
Create an input for all text field types
public abstract string GetTextEditor(string htmlName, string htmlValue, string htmlId, bool readOnly, bool required)
Parameters
Returns
GetWidgetDashboard()
create the admin dashboard with all widget addons.
public abstract string GetWidgetDashboard()
Returns
GetWidgetDashboard(string)
create a portal dashboard with widgets from addons set in a portal
public abstract string GetWidgetDashboard(string portalGuid)
Parameters
portalGuidstringThe guid of the portal in which the dashboard displays. All addons in the portal marked as widgets.
Returns
NewListReport()
Create a new instance of a List Report. List reports have a list of data rows with filters on the left
[Obsolete("Deprecated. All report and tool helper classes are implemented through Contensive.AdminUI.", true)]
public abstract LayoutBuilderListBaseClass NewListReport()
Returns
NewToolForm()
Create a new instance of a Tool Form. Tool Forms are simple forms with key elements like buttons and header with a simple body
[Obsolete("Deprecated. All report and tool helper classes are implemented through Contensive.AdminUI.", true)]
public abstract LayoutBuilderToolFormBaseClass NewToolForm()
Returns
RedirectToPortalFeature(string, string)
set response to redirect to the portal feature and return blank. Use this method to redirect to a portal feature if a features addon is running outside the portal. For example, if the AccountList addon is running outside the Accounts portal, redirect to the Accounts portal with the AccountList feature.
public abstract string RedirectToPortalFeature(string portalGuid, string portalFeatureGuid)
Parameters
Returns
RedirectToPortalFeature(string, string, string)
set response to redirect to the portal feature and return blank. Use this method to redirect to a portal feature if a features addon is running outside the portal. For example, if the AccountList addon is running outside the Accounts portal, redirect to the Accounts portal with the AccountList feature.
public abstract string RedirectToPortalFeature(string portalGuid, string portalFeatureGuid, string linkAppend)