Class LayoutBuilderToolFormBaseClass

Namespace

Contensive.BaseClasses.LayoutBuilder

Assembly

CPBase.dll

Create a Tool Form. Tool Forms how rows of input elements

[Obsolete("Deprecated. Use cp.AdminUi.CreateLayoutBuilder", false)]
public abstract class LayoutBuilderToolFormBaseClass : LayoutBuilderBaseClass

Inheritance

object

LayoutBuilderBaseClass

LayoutBuilderToolFormBaseClass

Inherited Members

LayoutBuilderBaseClass.cp

LayoutBuilderBaseClass.addActiveFilter(string, string, string)

LayoutBuilderBaseClass.addFilterGroup(string)

LayoutBuilderBaseClass.getFilterBoolean(string, string)

LayoutBuilderBaseClass.getFilterText(string, string)

LayoutBuilderBaseClass.getFilterInteger(string, string)

LayoutBuilderBaseClass.getFilterDate(string, string)

LayoutBuilderBaseClass.addFilterCheckbox(string, string, string, bool)

LayoutBuilderBaseClass.addFilterRadio(string, string, string, bool)

LayoutBuilderBaseClass.addFilterTextInput(string, string, string)

LayoutBuilderBaseClass.addFilterDateInput(string, string, DateTime?)

LayoutBuilderBaseClass.addFilterSelect(string, string, List<NameValueSelected>)

LayoutBuilderBaseClass.addFilterSelectContent(string, string, int, string, string)

LayoutBuilderBaseClass.addFilterSelectContent(string, string, int, string, string, string)

LayoutBuilderBaseClass.callbackAddonGuid

LayoutBuilderBaseClass.includeBodyPadding

LayoutBuilderBaseClass.includeBodyColor

LayoutBuilderBaseClass.isOuterContainer

LayoutBuilderBaseClass.includeForm

LayoutBuilderBaseClass.title

LayoutBuilderBaseClass.warningMessage

LayoutBuilderBaseClass.failMessage

LayoutBuilderBaseClass.infoMessage

LayoutBuilderBaseClass.successMessage

LayoutBuilderBaseClass.description

LayoutBuilderBaseClass.styleSheet

LayoutBuilderBaseClass.javascript

LayoutBuilderBaseClass.portalSubNavTitleList

LayoutBuilderBaseClass.portalSubNavTitle

LayoutBuilderBaseClass.allowDownloadButton

LayoutBuilderBaseClass.requestDownload

LayoutBuilderBaseClass.getHtml()

LayoutBuilderBaseClass.addFormHidden(string, string, string)

LayoutBuilderBaseClass.addFormHidden(string, string)

LayoutBuilderBaseClass.addFormHidden(string, int, string)

LayoutBuilderBaseClass.addFormHidden(string, int)

LayoutBuilderBaseClass.addFormHidden(string, double, string)

LayoutBuilderBaseClass.addFormHidden(string, double)

LayoutBuilderBaseClass.addFormHidden(string, DateTime, string)

LayoutBuilderBaseClass.addFormHidden(string, DateTime)

LayoutBuilderBaseClass.addFormHidden(string, bool, string)

LayoutBuilderBaseClass.addFormHidden(string, bool)

LayoutBuilderBaseClass.addLinkButton(string, string)

LayoutBuilderBaseClass.addLinkButton(string, string, string)

LayoutBuilderBaseClass.addLinkButton(string, string, string, string)

LayoutBuilderBaseClass.addFormButton(string)

LayoutBuilderBaseClass.addFormButton(string, string)

LayoutBuilderBaseClass.addFormButton(string, string, string)

LayoutBuilderBaseClass.addFormButton(string, string, string, string)

LayoutBuilderBaseClass.formActionQueryString

LayoutBuilderBaseClass.body

LayoutBuilderBaseClass.htmlLeftOfBody

LayoutBuilderBaseClass.htmlBeforeBody

LayoutBuilderBaseClass.htmlAfterBody

LayoutBuilderBaseClass.blockFormTag

LayoutBuilderBaseClass.refreshQueryString

LayoutBuilderBaseClass.warning

LayoutBuilderBaseClass.footer

LayoutBuilderBaseClass.formid

LayoutBuilderBaseClass.getHtml(CPBaseClass)

LayoutBuilderBaseClass.baseUrl

LayoutBuilderBaseClass.baseAjaxUrl

LayoutBuilderBaseClass.csvDownloadFilename

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LayoutBuilderToolFormBaseClass(CPBaseClass)

public LayoutBuilderToolFormBaseClass(CPBaseClass cp)

Parameters

cp CPBaseClass

Properties

Body

The main html of the tool form

public abstract string Body { get; set; }

Property Value

string

Description

Description appears right below title

public abstract string Description { get; set; }

Property Value

string

FailMessage

When an action is requested, use this position to inform error

public abstract string FailMessage { get; set; }

Property Value

string

Footer

html block below the body

public abstract string Footer { get; set; }

Property Value

string

FormActionQueryString

This report will be wrapped in a form tag and the action should send traffic back to the same page. If empty, the form uses cp.Doc.RefreshQueryString

[Obsolete("Deprecated. No longer needed.", false)]
public abstract string FormActionQueryString { get; set; }

Property Value

string

FormId

public abstract string FormId { get; set; }

Property Value

string

IncludeBodyColor

Add background color to the body

public abstract bool IncludeBodyColor { get; set; }

Property Value

bool

IncludeBodyPadding

Add padding around the body

public abstract bool IncludeBodyPadding { get; set; }

Property Value

bool

InfoMessage

When an action is requested, use this position to inform info

public abstract string InfoMessage { get; set; }

Property Value

string

IsOuterContainer

Set true if this tool is requested directly and not embedded in another AdminUI form

public abstract bool IsOuterContainer { get; set; }

Property Value

bool

SuccessMessage

When an action is requested, use this position to inform success

public abstract string SuccessMessage { get; set; }

Property Value

string

Title

The title of the form

public abstract string Title { get; set; }

Property Value

string

WarningMessage

When an action is requested, use this position to inform warn

public abstract string WarningMessage { get; set; }

Property Value

string

Methods

AddFormButton(string)

Add form button

public abstract void AddFormButton(string buttonValue)

Parameters

buttonValue string

AddFormButton(string, string)

Add form button

public abstract void AddFormButton(string buttonValue, string buttonName)

Parameters

buttonValue string

buttonName string

AddFormButton(string, string, string)

Add form button

public abstract void AddFormButton(string buttonValue, string buttonName, string buttonId)

Parameters

buttonValue string

buttonName string

buttonId string

AddFormButton(string, string, string, string)

Add form button

public abstract void AddFormButton(string buttonValue, string buttonName, string buttonId, string buttonClass)

Parameters

buttonValue string

buttonName string

buttonId string

buttonClass string

AddFormHidden(string, bool)

Add hidden form input

public abstract void AddFormHidden(string name, bool value)

Parameters

name string

value bool

AddFormHidden(string, DateTime)

Add hidden form input

public abstract void AddFormHidden(string name, DateTime value)

Parameters

name string

value DateTime

AddFormHidden(string, double)

Add hidden form input

public abstract void AddFormHidden(string name, double value)

Parameters

name string

value double

AddFormHidden(string, int)

Add hidden form input

public abstract void AddFormHidden(string name, int value)

Parameters

name string

value int

AddFormHidden(string, string)

Add hidden form input

public abstract void AddFormHidden(string Name, string Value)

Parameters

Name string

Value string

GetHtml(CPBaseClass)

Method retrieves the rendered html. Call this method after populating all object elements

[Obsolete("Deprecated. Use getHtml()", false)]
public abstract string GetHtml(CPBaseClass cp)

Parameters

cp CPBaseClass

Returns

string