Class TagCloud

Represents the TagCloud UI element.

Inheritance

System.Object

CommonDataBoundControl

TagCloud

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService

Inherited Members

CommonDataBoundControl.PerformDataBinding(IEnumerable)

CommonDataBoundControl.RaisePostBackEvent(String)

CommonDataBoundControl.OnLoad(EventArgs)

CommonDataBoundControl.OnPreRender(EventArgs)

CommonDataBoundControl.RenderContents(HtmlTextWriter)

Namespace: Syncfusion.JavaScript.Web

Assembly: Syncfusion.EJ.Web.dll

Syntax

public class TagCloud : CommonDataBoundControl, INamingContainer, IPostBackEventHandler, IPostBackDataHandler, IUrlResolutionService

Constructors

TagCloud()

Declaration

public TagCloud()

Properties

ClientSideOnClick

Occurs when the TagCloud items are clicked.

Declaration

public string ClientSideOnClick { get; set; }

Property Value

Type	Description
System.String	The client side on click.

ClientSideOnCreate

Occurs when the TagCloud are created.

Declaration

public string ClientSideOnCreate { get; set; }

Property Value

Type	Description
System.String	The client side on create.

ClientSideOnDestroy

Occurs when the TagCloud are destroyed.

Declaration

public string ClientSideOnDestroy { get; set; }

Property Value

Type	Description
System.String	The client side on destroy.

ClientSideOnMouseOut

Occurs when the cursor leaves out from a tag item.

Declaration

public string ClientSideOnMouseOut { get; set; }

Property Value

Type	Description
System.String	The client side on mouse out.

ClientSideOnMouseOver

Occurs when the cursor hovers on a tag item.

Declaration

public string ClientSideOnMouseOver { get; set; }

Property Value

Type	Description
System.String	The client side on mouse over.

CssClass

Gets or sets the CSS class to button to achieve custom theme.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The css class.

DataFrequencyField

Gets or sets the frequency number to categorize the font size.

Declaration

public string DataFrequencyField { get; set; }

Property Value

Type	Description
System.String	The data frequency field.

DataManager

Data Manager as Inner property, which help us to bind the data sources from data adaptors

Declaration

public DataSource DataManager { get; set; }

Property Value

Type	Description
DataSource

DataSource

Gets or sets the dataSource.

Declaration

[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The datasource.

DataSourceCachingMode

Gets or sets the datasource caching mode.

Declaration

public DataSourceCachingMode DataSourceCachingMode { get; set; }

Property Value

Type	Description
DataSourceCachingMode	The datasource caching mode.

DataTextField

Gets or sets the data text field.

Declaration

public string DataTextField { get; set; }

Property Value

Type	Description
System.String	The data text field.

DataUrlField

Gets or sets the URL link to navigate while click the tag.

Declaration

public string DataUrlField { get; set; }

Property Value

Type	Description
System.String	The data url field.

EmptyDataText

Specifies the error message for Tagcloud.

Declaration

public string EmptyDataText { get; set; }

Property Value

Type	Description
System.String	The empty data text.

EnableRTL

Gets or sets the TagCloud and tag items direction as right to left alignment.

Declaration

public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	true if [enableRTL]; otherwise, false

Format

Defines the format for the TagCloud to display the tag items.

Declaration

[JsonConverter(typeof(StringEnumConverter))]
public Formats Format { get; set; }

Property Value

Type	Description
Formats	The format.

MaxFontSize

Gets or sets the maximum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values.

Declaration

public string MaxFontSize { get; set; }

Property Value

Type	Description
System.String	The max font size.

MinFontSize

Gets or sets the minimum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values.

Declaration

public string MinFontSize { get; set; }

Property Value

Type	Description
System.String	The min font size.

Model

Gets or sets the TagCloudProperties to the model

Declaration

public TagCloudProperties Model { get; set; }

Property Value

Type	Description
TagCloudProperties

Query

Gets or sets the query to retrieve the data from online server. The query is used only when the online dataSource is used.

Declaration

[JsonConverter(typeof(QueryConverter))]
public string Query { get; set; }

Property Value

Type	Description
System.String	The query.

ShowTitle

Gets or sets TagCloud showtitle.

Declaration

public bool ShowTitle { get; set; }

Property Value

Type	Description
System.Boolean	true if [showTitle]; otherwise, false

TagCloudFields

Get the mapping fields for the data items of the TagCloud.

Declaration

public TagCloudFields TagCloudFields { get; }

Property Value

Type	Description
TagCloudFields	The tag cloud fields.

Title

Gets or sets the title text for the TagCloud. To show the title text, the showTitle property should be enabled.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	The title.

TitleImage

Gets or sets the title image for the TagCloud. To show the title image, the showTitle property should be enabled.

Declaration

public string TitleImage { get; set; }

Property Value

Type	Description
System.String	The title image.

Methods

DependentScripts()

Represents the dependent scripts for TagCloud control.

Declaration

public List<string> DependentScripts()

Returns

Type	Description
System.Collections.Generic.List<System.String>	This method returns the list of dependent script files which is of type string

FetchData(IEnumerable)

Fetching the data

Declaration

public override void FetchData(IEnumerable data)

Parameters

Type	Name	Description
System.Collections.IEnumerable	data

Overrides

CommonDataBoundControl.FetchData(IEnumerable)

GetDependentFiles()

Get the dependent files for Tagcloud control

Declaration

public override List<string> GetDependentFiles()

Returns

Type	Description
System.Collections.Generic.List<System.String>

Overrides

CommonDataBoundControl.GetDependentFiles()

LoadViewState(Object)

Restores view-state information from a previous page request.

Declaration

protected override void LoadViewState(object state)

Parameters

Type	Name	Description
System.Object	state

Overrides

CommonDataBoundControl.LoadViewState(Object)

PostBackEventHandler(String, Dictionary<String, Object>)

Gets a value that indicates whether the page is being loaded in response to a postback.

Declaration

public override void PostBackEventHandler(string EventName, Dictionary<string, object> args)

Parameters

Type	Name	Description
System.String	EventName
System.Collections.Generic.Dictionary<System.String, System.Object>	args

Overrides

CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)

Render()

Render this instance

Declaration

public string Render()

Returns

Type	Description
System.String

Render(HtmlTextWriter)

Render method for rendering control

Declaration

protected override void Render(HtmlTextWriter writer)

Parameters

Type	Name	Description
System.Web.UI.HtmlTextWriter	writer

Overrides

CommonDataBoundControl.Render(HtmlTextWriter)

SaveViewState()

Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

Declaration

protected override object SaveViewState()

Returns

Type	Description
System.Object

UpdateServerModel(Dictionary<String, Object>)

Model values to retain on server side.

Declaration

public override void UpdateServerModel(Dictionary<string, object> ClientModel)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	ClientModel

Overrides

CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

Events

Click

Occurs when tagcloud click.

Declaration

public event TagCloud.TagCloudEventHandler Click

Event Type

Type	Description
TagCloud.TagCloudEventHandler

Implements

System.Web.UI.INamingContainer

System.Web.UI.IPostBackEventHandler

System.Web.UI.IPostBackDataHandler

System.Web.UI.IUrlResolutionService