BuildString() Method

In This Topic

Returns a compact string representation of this CellStyle.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function BuildString() As String

public string BuildString()

Return Value

A string containing the settings of all style elements defined in this CellStyle.

Remarks

This method is used to persist grid styles and can be used to define and save 'skins'.

See the CellStyleCollection.BuildString and CellStyleCollection.ParseString methods.

The string returned contains definitions only for the style elements that are defined by this CellStyle. Elements inherited from other styles are not included. To build a string containing specific elements, use the BuildString(StyleElementFlags) method instead.

Example

The code below creates a style with a custom font and background color and builds a string that represents the new style. Then it uses the string to initialize a second style.

// create style with custom font and back color
CellStyle cs = _flex.Styles.Add("s1");
cs.Font = new Font("Arial", 12, FontStyle.Bold);
cs.BackColor = Color.Beige;
            
// save style definition into a string
string styleDef = cs.BuildString();
            
// use string to initialize another style
CellStyle csNew = _flex.Styles.Add("s2");
csNew.ParseString(styleDef);
            
// compare styles
Debug.Assert(csNew.Font.Equals(cs.Font));
Debug.Assert(csNew.BackColor.Equals(cs.BackColor));

Reference

CellStyle Class
CellStyle Members
Overload List