Class CodeSnippetsContainer
Represents a class containing code snippets and inner code snippets containers.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Edit.Utils.CodeSnippets
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public class CodeSnippetsContainer : IXmlSerializable, IEnumerable
Constructors
CodeSnippetsContainer()
Initializes a new instance of the CodeSnippetsContainer class.
Declaration
public CodeSnippetsContainer()
Properties
ContainersNames
Gets the names of inner containers in code snippet popup window.
Declaration
public ArrayList ContainersNames { get; }
Property Value
Type |
---|
System.Collections.ArrayList |
ContainersNumber
Gets the number of containers in the form.
Declaration
public int ContainersNumber { get; }
Property Value
Type |
---|
System.Int32 |
IsEmpty
Gets a value indicating whether the container is empty or not.
Declaration
public bool IsEmpty { get; }
Property Value
Type |
---|
System.Boolean |
Name
Gets or sets the name of container.
Declaration
public string Name { get; set; }
Property Value
Type |
---|
System.String |
SnippetsNames
Gets the names of code snippets.
Declaration
public ArrayList SnippetsNames { get; }
Property Value
Type |
---|
System.Collections.ArrayList |
Methods
AddContainer(CodeSnippetsContainer)
Adds new inner container to the collection.
Declaration
public void AddContainer(CodeSnippetsContainer container)
Parameters
Type | Name | Description |
---|---|---|
CodeSnippetsContainer | container | Container to add. |
AddSnippet(CodeSnippet)
Adds new code snippet to the collection.
Declaration
public void AddSnippet(CodeSnippet snippet)
Parameters
Type | Name | Description |
---|---|---|
CodeSnippet | snippet | Code snippet to add. |
GetContainerByName(String)
Gets inner container by its name.
Declaration
public CodeSnippetsContainer GetContainerByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of container. |
Returns
Type | Description |
---|---|
CodeSnippetsContainer | Found container or null is nothing was found. |
GetEnumerator()
Gets enumerator for collection of snippets.
Declaration
public IEnumerator GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.IEnumerator | IEnumerator. |
GetSchema()
Gets the schema (Not used for proper interface implementation).
Declaration
public XmlSchema GetSchema()
Returns
Type | Description |
---|---|
System.Xml.Schema.XmlSchema | XmlSchema. |
GetSnippetByShortcut(String)
Gets code snippet by its shortcut.
Declaration
public CodeSnippet GetSnippetByShortcut(string shortcut)
Parameters
Type | Name | Description |
---|---|---|
System.String | shortcut | Shortcut of code snippet that has to be found. |
Returns
Type | Description |
---|---|
CodeSnippet | Needed code snippet or null if there's no snippet with given shortcut. |
GetSnippetByTitle(String)
Gets code snippet by its title.
Declaration
public CodeSnippet GetSnippetByTitle(string title)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | Title of code snippet that has to be found. |
Returns
Type | Description |
---|---|
CodeSnippet | Needed code snippet or null if there's no snippet with given title. |
ReadXml(XmlReader)
Performs custom Xml deserialization.
Declaration
public void ReadXml(XmlReader reader)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlReader | reader | XmlReader. |
RemoveContainer(String)
Removes container with given name from collection of inner containers.
Declaration
public void RemoveContainer(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of container to remove. |
RemoveSnippet(String)
Removes snippet with given title from collection of code snippets.
Declaration
public void RemoveSnippet(string title)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | Title of snippet to remove. |
WriteXml(XmlWriter)
Performs custom Xml serialization.
Declaration
public void WriteXml(XmlWriter writer)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlWriter | writer | XmlWriter. |
Events
NameChanging
Raised when name of the container is going to be changed.
Declaration
public event ValueChangedEventHandler NameChanging
Event Type
Type |
---|
ValueChangedEventHandler |