Class CKSections
Inherited Members
Namespace: CoverageKiller2.DOM
Assembly: CoverageKiller2.dll
Syntax
public class CKSections : ACKRangeCollection, IDOMObject, IEnumerable<CKSection>, IEnumerable
Constructors
CKSections(Sections, IDOMObject)
Initializes a new instance of the CKSections class.
Declaration
public CKSections(Sections collection, IDOMObject parent)
Parameters
Type | Name | Description |
---|---|---|
Sections | collection | |
IDOMObject | parent | The parent CKRange to associate with this instance. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the parent parameter is null. |
Properties
COMSections
Probably will get hidden. Avoid use if possible.
Declaration
public Sections COMSections { get; }
Property Value
Type | Description |
---|---|
Sections |
Count
Gets the number of sections in the range.
Declaration
public override int Count { get; }
Property Value
Type | Description |
---|---|
int |
Overrides
IsDirty
Indicates whether this DOM object has unsaved changes.
Declaration
public override bool IsDirty { get; protected set; }
Property Value
Type | Description |
---|---|
bool |
Overrides
IsOrphan
Determines whether the collection has lost association with the underlying Word objects.
Declaration
public override bool IsOrphan { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
this[int]
TODO: cache these Gets the CKSection at the specified one-based index.
Declaration
public CKSection this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | The one-based index of the section to retrieve. |
Property Value
Type | Description |
---|---|
CKSection | The CKSection at the specified index. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | Thrown when the index is less than 1 or greater than the number of sections. |
Methods
Clear()
Clears the collection cache.
Declaration
public override void Clear()
Overrides
GetEnumerator()
Returns an enumerator that iterates through the collection of CKSection objects.
Declaration
public IEnumerator<CKSection> GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<CKSection> | An enumerator for the collection of CKSection objects. |
IndexOf(object)
Attempts to find the index of an object within the collection.
Declaration
public override int IndexOf(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj |
Returns
Type | Description |
---|---|
int |
Overrides
ToString()
Returns a string representation of the CKSections collection.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string | A string containing the count of sections. |