Class TextBoxShapeBase
This is base class for text box shapes such as TextBox and Comment.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Shapes
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class TextBoxShapeBase : ShapeImpl, IShape, IParentApplication, IDisposable, ICloneParent, INamedObject
Constructors
TextBoxShapeBase(IApplication, Object)
Initializes new instance of the class.
Declaration
public TextBoxShapeBase(IApplication application, object parent)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the new item. |
System.Object | parent | Parent object for the new item. |
TextBoxShapeBase(IApplication, Object, MsofbtSpContainer, ExcelParseOptions)
Extracts comment from MsofbtSpContainer.
Declaration
public TextBoxShapeBase(IApplication application, object parent, MsofbtSpContainer container, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | Application object for the current object. |
System.Object | parent | Parent object for the current object. |
MsofbtSpContainer | container | Container that represents comment. |
ExcelParseOptions | options | Parse options. |
Fields
m_sheet
Represents worksheet
Declaration
protected WorksheetImpl m_sheet
Field Value
Type |
---|
WorksheetImpl |
Properties
ColorObject
Color Object.
Declaration
public ColorObject ColorObject { get; set; }
Property Value
Type |
---|
ColorObject |
FillColor
Shape filling color.
Declaration
public Color FillColor { get; set; }
Property Value
Type |
---|
Windows.UI.Color |
HAlignment
Horizontal alignment of the text.
Declaration
public ExcelCommentHAlign HAlignment { get; set; }
Property Value
Type |
---|
ExcelCommentHAlign |
IsTextLocked
Indicates whether comment text is locked.
Declaration
public bool IsTextLocked { get; set; }
Property Value
Type |
---|
System.Boolean |
RichText
Comment text.
Declaration
public IRichTextString RichText { get; set; }
Property Value
Type |
---|
IRichTextString |
Text
Gets or sets text box text.
Declaration
public string Text { get; set; }
Property Value
Type |
---|
System.String |
TextRotation
Text rotation.
Declaration
public ExcelTextRotation TextRotation { get; set; }
Property Value
Type |
---|
ExcelTextRotation |
UnknownBodyProperties
Gets or sets the unknown body properties
Declaration
public Dictionary<string, string> UnknownBodyProperties { get; set; }
Property Value
Type |
---|
System.Collections.Generic.Dictionary<System.String, System.String> |
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
CopyFrom(TextBoxShapeBase, Dictionary<Int32, Int32>)
Copies data from another comment shape.
Declaration
public void CopyFrom(TextBoxShapeBase source, Dictionary<int, int> dicFontIndexes)
Parameters
Type | Name | Description |
---|---|---|
TextBoxShapeBase | source | Text shape to copy from. |
System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
CreateDefaultOptions()
Creates default shape options.
Declaration
protected override MsofbtOPT CreateDefaultOptions()
Returns
Type | Description |
---|---|
MsofbtOPT | Record containing default options. |
Overrides
Dispose()
Dispose TextBoxShape
Declaration
public override void Dispose()
Overrides
GetClientTextBoxRecord(MsoBase)
Creates ClientTextBox record corresponding to this shape.
Declaration
protected MsofbtClientTextBox GetClientTextBoxRecord(MsoBase parent)
Parameters
Type | Name | Description |
---|---|---|
MsoBase | parent | Parent record for ClientTextBox. |
Returns
Type | Description |
---|---|
MsofbtClientTextBox | Extracted Textbox record. |
GetClientTextBoxRecord(MsoBase, ExcelCommentVAlign)
Creates ClientTextBox record corresponding to this shape.
Declaration
protected MsofbtClientTextBox GetClientTextBoxRecord(MsoBase parent, ExcelCommentVAlign vAlign)
Parameters
Type | Name | Description |
---|---|---|
MsoBase | parent | Parent record for ClientTextBox. |
ExcelCommentVAlign | vAlign |
Returns
Type | Description |
---|---|
MsofbtClientTextBox | Extracted Textbox record. |
InitializeVariables()
Initializes variables.
Declaration
protected virtual void InitializeVariables()
ParseClientTextBoxRecord(MsofbtClientTextBox, ExcelParseOptions)
Parses ClientTextBox record.
Declaration
protected virtual void ParseClientTextBoxRecord(MsofbtClientTextBox textBox, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtClientTextBox | textBox | Record to parse. |
ExcelParseOptions | options | Parse options. |
ParseOtherRecords(MsoBase, ExcelParseOptions)
Parses all unknown for ShapeImpl records.
Declaration
protected override void ParseOtherRecords(MsoBase subRecord, ExcelParseOptions options)
Parameters
Type | Name | Description |
---|---|---|
MsoBase | subRecord | Record to parse. |
ExcelParseOptions | options | Parse options. |
Overrides
SerializeOptions(MsoBase)
Serializes comment's options.
Declaration
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
SerializeTextDirection(MsofbtOPT)
Serializes text direction.
Declaration
protected void SerializeTextDirection(MsofbtOPT options)
Parameters
Type | Name | Description |
---|---|---|
MsofbtOPT | options | MsofbtOPT record to which text ID will be added. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | If options argument is NULL. |