Class TagCloudPropertiesBuilder

Inheritance

System.Object

TagCloudPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class TagCloudPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

TagCloudPropertiesBuilder()

Initializes a new instance of the TagCloudPropertiesBuilder class.

Declaration

public TagCloudPropertiesBuilder()

TagCloudPropertiesBuilder(TagCloud)

Initializes a new instance of the TagCloudPropertiesBuilder class.

Declaration

public TagCloudPropertiesBuilder(TagCloud tagCloud)

Parameters

Type	Name	Description
TagCloud	tagCloud	Accepts TagCloud properties

Fields

tagCloud

Initializes a new instance of the TagCloud class.

Declaration

public TagCloud tagCloud

Field Value

Type	Description
TagCloud

Methods

ClientSideEvents(Action<TagCloudClientSideEventsBuilder>)

TagCloud ClientSideEvents

Declaration

public TagCloudPropertiesBuilder ClientSideEvents(Action<TagCloudClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<TagCloudClientSideEventsBuilder>	clientSideEvents	clientSideEvents

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns TagCloud properties builder value

CssClass(String)

Specify the CSS class to button to achieve custom theme.

Declaration

public TagCloudPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string value

Datasource(DataSource)

The dataSource contains the list of data to display in a cloud format. Each data contains a link url, frequency to categorize the font size and a display text.Here the variable passed is in DataSource type.

Declaration

public TagCloudPropertiesBuilder Datasource(DataSource dataSource)

Parameters

Type	Name	Description
DataSource	dataSource	dataSource

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns tagcloud properties builder value

Datasource(Action<DataSourceBuilder>)

The dataSource contains the list of data to display in a cloud format. Each data contains a link url, frequency to categorize the font size and a display text.

Declaration

public TagCloudPropertiesBuilder Datasource(Action<DataSourceBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	dataSource	dataSource

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns tagcloud properties builder value

Datasource(IEnumerable)

The dataSource contains the list of data to display in a cloud format. Each data contains a link url, frequency to categorize the font size and a display text.Here the variable passed is in IEnumerable type.

Declaration

public TagCloudPropertiesBuilder Datasource(IEnumerable dataSource)

Parameters

Type	Name	Description
System.Collections.IEnumerable	dataSource	dataSource

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns tagcloud properties builder value

EnableRTL()

Sets the TagCloud and tag items direction as right to left alignment.

Declaration

public TagCloudPropertiesBuilder EnableRTL()

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns boolean value

EnableRTL(Boolean)

Sets the TagCloud and tag items direction as right to left alignment.A boolean variable enableRTL is passed as an argument.

Declaration

public TagCloudPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns boolean value

Format(Formats)

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

Declaration

public TagCloudPropertiesBuilder Format(Formats format)

Parameters

Type	Name	Description
Formats	format	format

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string|enum value

HtmlAttributes(IDictionary<String, Object>)

Specifies the list of html attributes to be added to TagCloud control.

Declaration

public TagCloudPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	itemHtmlAttributes

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns object value

MaxFontSize(String)

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 TagCloudPropertiesBuilder MaxFontSize(string maxFontSize)

Parameters

Type	Name	Description
System.String	maxFontSize	maxFontSize

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string value

MinFontSize(String)

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 TagCloudPropertiesBuilder MinFontSize(string minFontSize)

Parameters

Type	Name	Description
System.String	minFontSize	minFontSize

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string value

Query(String)

Define the query to retrieve the data from online server. The query is used only when the online dataSource is used.

Declaration

public TagCloudPropertiesBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query	query

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string value

Render()

Renders this instance.

Declaration

public void Render()

ShowTitle()

Shows or hides the TagCloud title. When this set to false, it hides the TagCloud header.

Declaration

public TagCloudPropertiesBuilder ShowTitle()

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns boolean value

ShowTitle(Boolean)

Shows or hides the TagCloud title. When this set to false, it hides the TagCloud header.A boolean variable showTitle is passed as an argument.

Declaration

public TagCloudPropertiesBuilder ShowTitle(bool showTitle)

Parameters

Type	Name	Description
System.Boolean	showTitle	showTitle

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns boolean value

TagCloudFields(Action<TagCloudFieldsBuilder>)

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

Declaration

public TagCloudPropertiesBuilder TagCloudFields(Action<TagCloudFieldsBuilder> fields)

Parameters

Type	Name	Description
System.Action<TagCloudFieldsBuilder>	fields	fields

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns tagcloud properties builder value

Title(String)

Sets the title text for the TagCloud. To show the title text, the showTitle property should be enabled.

Declaration

public TagCloudPropertiesBuilder Title(string titleText)

Parameters

Type	Name	Description
System.String	titleText	titleText

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string value

TitleImage(String)

Sets the title image for the TagCloud. To show the title image, the showTitle property should be enabled.

Declaration

public TagCloudPropertiesBuilder TitleImage(string titleImage)

Parameters

Type	Name	Description
System.String	titleImage	titleImage

Returns

Type	Description
TagCloudPropertiesBuilder	This method returns string value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Implements

IPropertiesBuilder

System.Web.IHtmlString