Class CheckBoxShapeImpl
This class represents Checkbox form control.
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Shapes
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class CheckBoxShapeImpl : TextBoxShapeBase, IDisposable, ICloneParent, INamedObject, ICheckBoxShape, ITextBoxShape, ITextBox, IShape, IParentApplicationConstructors
CheckBoxShapeImpl(IApplication, Object)
Initialize new instance of the text box shape.
Declaration
public CheckBoxShapeImpl(IApplication application, object parent)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object for the new shape. |
| System.Object | parent | Parent object for the new shape. |
CheckBoxShapeImpl(IApplication, Object, MsofbtSpContainer, ExcelParseOptions)
Initializes new instance of the text box shape.
Declaration
[CLSCompliant(false)]
public CheckBoxShapeImpl(IApplication application, object parent, MsofbtSpContainer shapeContainer, ExcelParseOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object for the new shape. |
| System.Object | parent | Parent object for the new shape. |
| MsofbtSpContainer | shapeContainer | Shape's container. |
| ExcelParseOptions | options | Parsing options. |
Fields
ShapeInstance
Correct shape instance.
Declaration
public const int ShapeInstance = 201Field Value
| Type |
|---|
| System.Int32 |
Properties
CheckState
Indicates whether check box is checked.
Declaration
public ExcelCheckState CheckState { get; set; }Property Value
| Type |
|---|
| ExcelCheckState |
Display3DShading
indicates whether the option button is in 3D shading
Declaration
public bool Display3DShading { get; set; }Property Value
| Type |
|---|
| System.Boolean |
HAlignment
Horizontal alignment of the text.
Declaration
public ExcelCommentHAlign HAlignment { get; set; }Property Value
| Type |
|---|
| ExcelCommentHAlign |
Hyperlink
Get object that represents the hyperlink for the shape.
Declaration
public IHyperLink Hyperlink { get; }Property Value
| Type |
|---|
| IHyperLink |
LinkedCell
Gets or sets formula link value.
Declaration
public IRange LinkedCell { get; set; }Property Value
| Type |
|---|
| IRange |
TextRotation
Text rotation.
Declaration
public ExcelTextRotation TextRotation { get; set; }Property Value
| Type |
|---|
| ExcelTextRotation |
VAlignment
Vertical alignment of the text.
Declaration
public ExcelCommentVAlign VAlignment { get; set; }Property Value
| Type |
|---|
| ExcelCommentVAlign |
Methods
Clone(Object, Dictionary<String, String>, Dictionary<Int32, Int32>, Boolean)
Creates a clone of the current shape.
Declaration
public override IShape Clone(object parent, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes, bool addToCollections)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | parent | New parent for the shape object. |
| System.Collections.Generic.Dictionary<System.String, System.String> | hashNewNames | Dictionary with new worksheet names. |
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
| System.Boolean | addToCollections | Indicates whether we should add created shape into all necessary parent collections. |
Returns
| Type | Description |
|---|---|
| IShape | A copy of the current shape. |
Overrides
CreateDefaultOptions()
Creates default options.
Declaration
[CLSCompliant(false)]
protected override MsofbtOPT CreateDefaultOptions()Returns
| Type | Description |
|---|---|
| MsofbtOPT | MsofbtOPT record |
Overrides
OnPrepareForSerialization()
This method is called inside of PrepareForSerialization to make shape-dependent preparations.
Declaration
protected override void OnPrepareForSerialization()Overrides
ParseClientData(MsofbtClientData, ExcelParseOptions)
Parses client data record.
Declaration
[CLSCompliant(false)]
protected override void ParseClientData(MsofbtClientData clientData, ExcelParseOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| MsofbtClientData | clientData | Record to parse. |
| ExcelParseOptions | options | Parse options. |
Overrides
SerializeOptions(MsoBase)
Serializes comment's options.
Declaration
[CLSCompliant(false)]
protected override MsofbtOPT SerializeOptions(MsoBase parent)Parameters
| Type | Name | Description |
|---|---|---|
| MsoBase | parent | Parent record for options. |
Returns
| Type | Description |
|---|---|
| MsofbtOPT | All options in MsofbtOPT record. |
Overrides
SerializeShape(MsofbtSpgrContainer)
Serializes current shape.
Declaration
[CLSCompliant(false)]
protected override void SerializeShape(MsofbtSpgrContainer spgrContainer)Parameters
| Type | Name | Description |
|---|---|---|
| MsofbtSpgrContainer | spgrContainer | Container that will receive this comment. |