com.grapecity.documents.excel

Interface IStyleCollection

All Superinterfaces:

java.lang.Iterable<IStyle>

public interface IStyleCollection
extends java.lang.Iterable<IStyle>

Represents a collection of all the IStyle objects in the specified or active workbook.

Method Summary

Modifier and Type	Method and Description
IStyle	add(java.lang.String name) Creates a new IStyle and adds it to the list of styles that are available for the current IWorkbook.
IStyle	add(java.lang.String name, IRange baseOn) Creates a new IStyle and adds it to the list of styles that are available for the current IWorkbook.
IStyle	add(java.lang.String name, IStyle baseOn) Creates a new IStyle and adds it to the list of styles that are available for the current IWorkbook.
boolean	contains(java.lang.String name) Determines whether the style name is contained in IStyleCollection.
IStyle	get(int index) Returns the IStyle object from a collection.
IStyle	get(java.lang.String name) Returns the IStyle object from a collection.
int	getCount() Returns the number of objects in the collection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getCount

int getCount()

Returns the number of objects in the collection.

get

IStyle get(java.lang.String name)

Returns the IStyle object from a collection.

Parameters:

name - Specifies the name of an element in the collection.

get

IStyle get(int index)

Returns the IStyle object from a collection.

Parameters:

index - Specifies the index of an element in the collection.

contains

boolean contains(java.lang.String name)

Determines whether the style name is contained in IStyleCollection.

Parameters:

name - The style name.

Returns:

Whether the style name is contained.

add

IStyle add(java.lang.String name)

Creates a new IStyle and adds it to the list of styles that are available for the current IWorkbook. This method is functionally equivalent to add(String name, IRange baseOn) with baseOn = null.

Parameters:

name - The new IStyle name.

add

IStyle add(java.lang.String name,
           IRange baseOn)

Creates a new IStyle and adds it to the list of styles that are available for the current IWorkbook.

Parameters:

name - The new IStyle name.

baseOn - An IRange object that refers to a cell that's used as the basis for the new style. If this argument is omitted, the newly created style is based on the Normal style.

Returns:

The new IStyle.

add

IStyle add(java.lang.String name,
           IStyle baseOn)

Creates a new IStyle and adds it to the list of styles that are available for the current IWorkbook.

Parameters:

name - The new IStyle name.

baseOn - An IRange object that refers to be used as the basis for the new style.

Returns:

The new IStyle.