Documentation > CMS Template API Library > Input

CrownPeak.CMSAPI.Input

A collection of methods used to create input controls.

NameDescriptionType
AddHiddenField(String,AssetType)

Add a hidden input field to the form with the given name and assettype, produces "File" or "Folder"

Method
AddHiddenField(String,Int32)

Add a hidden input field to the form with the given name and int value

Method
AddHiddenField(String,String)

Add a hidden input field to the form with the given name and string value

Method
EndControlPanel()

Marks the end of the control panel.

Method
EndDropDownContainer()

Closes the drop down container. Will throw an error if called without first calling StartDropDownContainer.

Method
EndExpandPanel()

Closes the expand panel.

Method
EndHorizontalWrapContainer()

See

Method
EndTabbedPanel()

See

Method
NextDropDownContainer()

Advances the DropDownContainer to the next row. Will throw an error if called before calling StartDropDownContainer. Will throw an error if NextDropDownContainer is called more times than there items in the dictionary passed to StartDropDownContainer.

Method
NextPanel(List[AssetPanelEntry],AssetPanelEntryByRef,ListPanelType,Nullable[Int32],Nullable[Int32],SortOrder,String,Boolean)

Method
NextPanel(List[AssetPanelEntry],ListPanelType,Nullable[Int32],Nullable[Int32],SortOrder,String,Boolean)

Gets the next available panel from the supplied list. Use in the input to loop over a List of AssetPanelEntries which are returned by asset.GetPanelsFromFolder() or panel.GetPanelsFromFolder().

Method
NextPanel(String,ListPanelType,Nullable[Int32],Nullable[Int32],SortOrder,String,Boolean)

Gets the next available panel from the named list. Always returns at least one entry. Uses data already stored in the asset.

Method
NextTabbedPanel()

See

Method
ShowAcquireDocument(String,String,ShowAcquireParams,String,String)

Displays a "select" and "clear" button that is used to upload a document into the current template.

Method
ShowAcquireDocument(String,String,String,String)

Displays a "select" and "clear" button that is used to upload a document into the current template.

Method
ShowAcquireImage(String,String,ShowAcquireParams,String,String,String)

Displays a "select" and "clear" button that is used to upload an image into the current template. Note: You no longer need to use an upload.aspx, if you want to create a thumbnail. Use the AddAdditionalImage method on the ShowAcquireParams object to define the thumbnails that you want to create. See the examples below.

Method
ShowAcquireImage(String,String,String,String)

Displays a "select" and "clear" button that is used to upload an image into the current template.

Method
ShowAutoCompleteBox(String,String,Dictionary[String,String],Int32,String,String)

Adds an autocompletebox control to the input screen.

Method
ShowCheckBox(String,String,String,String,String,String,Nullable[Boolean],String)

Adds a checkbox control to the input screen.

Method
ShowCheckBox(String,String,String,String,String,String,Nullable[Boolean],String,Boolean)

Adds a checkbox control to the input screen.

Method
ShowDropDown(String,String,Dictionary[String,String],List[String],Int32,Boolean,String,String)

Shows a drop down menu selector control.

Method
ShowDropDown(String,String,String,String,List[String],Int32,Boolean,String,String)

Shows a drop down menu selector control.

Method
ShowHeader(String,String,String,Boolean)

Adds a section header to the input screen. Useful for highlighting groups of controls.

Method
ShowLink(Int32,String,InputLinkType,String)

Creates a link to another asset from the input form.

Method
ShowMessage(String,MessageType)

Adds a section message to the input screen. Useful for adding a message to groups of controls.

Method
ShowMessage(String,String,String)

Adds a section message to the input screen. Useful for adding a message to groups of controls. Uses a default message type -- MessageType.Basic. As of build 2669, foregroundColor and backgroundColor will now be ignored.

Method
ShowPassword(String,String,Int32,Int32,Int32,String,String)

Adds a password textbox control to the input screen. This features is provided as a convenience for developers. CrownPeak will not be responsible for the security of this password. Template developers will be responsible for handling the security of passwords submitted with this type of text box. Passwords can be handled in the post input template. They can be encrypted before storing or used and cleared depending on the usage. If they are not handled in the post_input, they will be stored in clear text in the asset content properties.

Method
ShowRadioButton(String,String,Dictionary[String,String],String,String,String)

Adds a group of radio buttons to the input screen. If the Optional: defaultValue, is provided the radio button will be initialized to the to the defaultValue. Using the Optional: helpMessage, will render help text.

Method
ShowRadioButton(String,String,Dictionary[String,String],String,String,String,Boolean)

Adds a group of radio buttons to the input screen. If the Optional: defaultValue, is provided the radio button will be initialized to the to the defaultValue. Using the Optional: helpMessage, will render help text.

Method
ShowSelectColor(String,String,String,String,String)

Shows a color selector control.

Method
ShowSelectDate(String,String,Boolean,Boolean,Int32,String,Boolean,String)

Shows a date selector control. Dates are stored in the format "MM/dd/yyyy".

Method
ShowSelectDateTime(String,String,Boolean,Boolean,Boolean,String,String)

Shows a date and time selector control. Dates and times are stored in the format "MM/dd/yyy HH:mm:ss" (24-hour time).

Method
ShowSelectFolder(String,String,AssetPath,String,String)

Displays a "select" and "clear" button that is used to select a folder.

Method
ShowSelectFolder(String,String,String,String,String)

Displays a "select" and "clear" button that is used to select a folder. Note: Before build 2481, there is a default value for the third argument of the overloaded version of this method. So until build 2481 and higher is available, you will need to pass a third argument to this function.

Method
ShowSelectList(String,String,Dictionary[String,String],List[String],Int32,SelectListSort,String,String)

Shows a list selector control, which allows the user to select values from a dictionary.

Method
ShowTextBox(String,String,String,Int32,Int32,Int32,String,Boolean,String)

Adds a textbox control to the input screen. If the Optional: height, is set to a value greater than 0, ShowTextBox will render a multiline textarea.

Method
ShowTextBox(String,String,String,Int32,Int32,Int32,String,Boolean,String,Boolean)

Adds a textbox control to the input screen. If the Optional: height, is set to a value greater than 0, ShowTextBox will render a multiline textarea.

Method
ShowWcoControls(String)

Adds Wco controls that will bind a field on the asset with a WCO Snippet. Should be paired with an editable text fields of the same name, like a TextBox or Wysiwyg

Method
ShowWysiwyg(String,String,WysiwygParams,String,Int32,Int32,String,String,String)

Shows the WYSIWYG control.

Method
StartControlPanel(String)

Creates an control panel. It is used to group a set of controls. You must close the control panel with an EndControlPanel.

Method
StartDropDownContainer(String,String,Dictionary[String,String],String,String)

Creates a dropdown that will show the controls associated with the currently selected value, while hiding those that are not. All controls that fall under the StartDropDownContainer will correspond to the first item in the rows dictionary. Supports nesting, so calling StartDropDownContainer within another DropDownConntainer will work as expected.

Method
StartExpandPanel(String)

Creates an expand panel. The expand panel presents itself as a single gray line that when clicked reveals the set of input controls that it wraps. You must close the expand panel with an EndExpandPanel.

Method
StartHorizontalWrapContainer()

Creates a container that arranges the contained controls horizontally. If the controls can't fit in one row, they wrap to a new row below the first.

Method
StartTabbedPanel(List[String])

Starts the tabbed panel. Similar to a windows panel, a tabbed panel (unlike an expand panel) displays a list of tabs that when selected shows the hidden panel.

Method
StartTabbedPanel(String[])

Starts the tabbed panel. Similar to a windows panel, a tabbed panel (unlike an expand panel) displays a list of tabs that when selected shows the hidden panel.

Method
CurrentPanel

Get the PanelEntry object corresponding to the current iteration during a NextPanel loop

Property

Connect with CrownPeak