Class HTMLFormatsCollection
Collection for formats.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.HTMLUI
Assembly: Syncfusion.HTMLUI.Windows.dll
Syntax
public class HTMLFormatsCollection : EventBaseCollection, IHTMLFormatsCollection, IList, IHTMLCollection, ICollection, IEnumerable, IDisposable
Constructors
HTMLFormatsCollection()
Initializes a new instance of the HTMLFormatsCollection class
Declaration
public HTMLFormatsCollection()
HTMLFormatsCollection(IHTMLElement)
Initializes a new instance of the HTMLFormatsCollection class
Declaration
public HTMLFormatsCollection(IHTMLElement parent)
Parameters
Type | Name | Description |
---|---|---|
IHTMLElement | parent | Parent element. |
Properties
Item[Int32]
Gets or sets the attribute with the specified index.
Declaration
public IHTMLFormat this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | An integer index value |
Property Value
Type |
---|
IHTMLFormat |
Item[String]
Gets or sets the format with the specified name. Name is case insensitive.
Declaration
public IHTMLFormat this[string name] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.String | name | A string value |
Property Value
Type |
---|
IHTMLFormat |
Parent
Gets the parent element of the current collection.
Declaration
public IHTMLElement Parent { get; }
Property Value
Type |
---|
IHTMLElement |
Methods
Add(IHTMLFormat)
Adds the specified format into the collection.
Declaration
public int Add(IHTMLFormat format)
Parameters
Type | Name | Description |
---|---|---|
IHTMLFormat | format | Format for adding into collection. |
Returns
Type | Description |
---|---|
System.Int32 | Index in the collection. |
AddRange(IHTMLFormat[])
Adds the range of formats into the collection.
Declaration
public void AddRange(IHTMLFormat[] formats)
Parameters
Type | Name | Description |
---|---|---|
IHTMLFormat[] | formats | Array of formats. |
Contains(IHTMLFormat)
Indicates whether the collection contains the specified format.
Declaration
public bool Contains(IHTMLFormat format)
Parameters
Type | Name | Description |
---|---|---|
IHTMLFormat | format | Format reference for check. |
Returns
Type | Description |
---|---|
System.Boolean | True if the collection contains such a format; false otherwise. |
Contains(String)
Indicates whether the collection contains the format with specified name.
Declaration
public bool Contains(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Case insensitive name of the format. |
Returns
Type | Description |
---|---|
System.Boolean | True if the collection contains such a format; false otherwise. |
Dispose()
Clears all resources.
Declaration
public void Dispose()
Finalize()
Finalizes an instance of the HTMLFormatsCollection class
Declaration
protected void Finalize()
IndexOf(IHTMLFormat)
Returns the index of the specified format; if collection does not contain such format, it will return -1.
Declaration
public int IndexOf(IHTMLFormat format)
Parameters
Type | Name | Description |
---|---|---|
IHTMLFormat | format | Format whose index is needed. |
Returns
Type | Description |
---|---|
System.Int32 | Zero-based index of format; -1 otherwise. |
IndexOf(String)
Returns the index of format of the format which contains the specified name.
Declaration
public int IndexOf(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Case insensitive name of the format. |
Returns
Type | Description |
---|---|
System.Int32 | Zero-based index of format; -1 otherwise. |
Remove(IHTMLFormat)
Removes the specified format from the collection, if it belongs to it.
Declaration
public void Remove(IHTMLFormat format)
Parameters
Type | Name | Description |
---|---|---|
IHTMLFormat | format | Reference of the format which must be removed from the collection. |
Remove(String)
Removes the format with the specified name.
Declaration
public void Remove(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Case insensitive name of format which must be removed. |