Interface IFormatManager
Provides the functionality for formats manager declaration interface.
Namespace: Syncfusion.Windows.Forms.Edit.Interfaces
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public interface IFormatManagerProperties
Item[FormatType]
Gets the format by its type, does not work for FormatType.Custom.
Declaration
ISnippetFormat this[FormatType type] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| FormatType | type |
Property Value
| Type |
|---|
| ISnippetFormat |
Item[Int32]
Gets the format by its indexes.
Declaration
ISnippetFormat this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| ISnippetFormat |
Item[String]
Gets the format by its name.
Declaration
ISnippetFormat this[string name] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Property Value
| Type |
|---|
| ISnippetFormat |
MaxCharWidth
Gets the maximum char width according to known object formats.
Declaration
int MaxCharWidth { get; }Property Value
| Type |
|---|
| System.Int32 |
MaxLineHeight
Gets the maximum height of line according to known object formats.
Declaration
int MaxLineHeight { get; }Property Value
| Type |
|---|
| System.Int32 |
MinCharWidth
Gets the minimum char width according to formats known object.
Declaration
int MinCharWidth { get; }Property Value
| Type |
|---|
| System.Int32 |
MinLineHeight
Gets the minimum height of line according to known object formats.
Declaration
int MinLineHeight { get; }Property Value
| Type |
|---|
| System.Int32 |
ShowWhiteSpaces
Gets or sets a value indicating whether the whitespaces should be shown as bullets.
Declaration
bool ShowWhiteSpaces { get; set; }Property Value
| Type |
|---|
| System.Boolean |
TabReplaceString
Gets the string, to be placed instead of tab.
Declaration
string TabReplaceString { get; }Property Value
| Type |
|---|
| System.String |
Methods
Add(String)
Creates a new format with unique name and add it into the format collection. FormatType will be set to Custom value.
Declaration
ISnippetFormat Add(string formatName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | formatName | new format unique name |
Returns
| Type | Description |
|---|---|
| ISnippetFormat | Created and added into collection format reference |
Add(String, ISnippetFormat)
Creates a new format that was inherited from the source format and add it into the format collection.
Declaration
ISnippetFormat Add(string formatName, ISnippetFormat source)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | formatName | unique format name |
| ISnippetFormat | source | format which setting must be inherited |
Returns
| Type | Description |
|---|---|
| ISnippetFormat | Created and added into collection format reference |
Add(String, String)
Creates a new format that was inherited from the source format and add it into the format collection.
Declaration
ISnippetFormat Add(string formatName, string sourceName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | formatName | unique format name |
| System.String | sourceName | Get source format by it unique name |
Returns
| Type | Description |
|---|---|
| ISnippetFormat | Created and added into collection format reference |
Remove(ISnippetFormat)
Removes the specified format from the collection by it reference.
Declaration
void Remove(ISnippetFormat format)Parameters
| Type | Name | Description |
|---|---|---|
| ISnippetFormat | format | reference on format |
Remove(String)
Remove the specified format from the collection by it unique name.
Declaration
void Remove(string formatName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | formatName | unique format name |