Class DataValidationCollection
Incapsulates one DValRecord and multiple DVRecords from xls file.
Inheritance
System.Object
DataValidationCollection
Implements
System.Collections.IEnumerable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class DataValidationCollection : CollectionBaseEx<DataValidationImpl>, IList<DataValidationImpl>, ICollection<DataValidationImpl>, IEnumerable<DataValidationImpl>, IEnumerable, IParentApplication, ICloneParent
Constructors
DataValidationCollection(IApplication, Object)
Declaration
public DataValidationCollection(IApplication application, object parent)
Parameters
Type |
Name |
Description |
IApplication |
application |
|
System.Object |
parent |
|
DataValidationCollection(IApplication, Object, DValRecord)
Declaration
[CLSCompliant(false)]
public DataValidationCollection(IApplication application, object parent, DValRecord dval)
Parameters
DataValidationCollection(IApplication, Object, List<BiffRecordRaw>, ref Int32)
Declaration
public DataValidationCollection(IApplication application, object parent, List<BiffRecordRaw> arrRecords, ref int iOffset)
Parameters
Type |
Name |
Description |
IApplication |
application |
|
System.Object |
parent |
|
System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> |
arrRecords |
|
System.Int32 |
iOffset |
|
Properties
DataValidations
Returns data validation records.
Declaration
public List<BiffRecordRaw> DataValidations { get; }
Property Value
Type |
Description |
System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw> |
|
IsPromptBoxPositionFixed
Declaration
public bool IsPromptBoxPositionFixed { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsPromptBoxVisible
Declaration
public bool IsPromptBoxVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Item[Int32]
Returns single entry from the collection. Read-only.
Declaration
public DataValidationImpl this[int index] { get; }
Parameters
Type |
Name |
Description |
System.Int32 |
index |
|
Property Value
ParentTable
Gets parent table. Read-only.
Declaration
public DataValidationTable ParentTable { get; }
Property Value
PromptBoxHPosition
Declaration
public int PromptBoxHPosition { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
PromptBoxVPosition
Declaration
public int PromptBoxVPosition { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Record
Gets DValRecord representing this collection. Read-only.
Declaration
[CLSCompliant(false)]
public DValRecord Record { get; }
Property Value
ShapesCount
Gets number of required shapes objects.
Declaration
public int ShapesCount { get; }
Property Value
Type |
Description |
System.Int32 |
|
Workbook
Declaration
public WorkbookImpl Workbook { get; }
Property Value
Worksheet
Declaration
public WorksheetImpl Worksheet { get; }
Property Value
Methods
Add(DataValidationImpl)
Adds data validation to the collection.
Checks if same data validation exists in the collection,
updates and returns it (if found).
Declaration
public DataValidationImpl Add(DataValidationImpl dv)
Parameters
Returns
AddDVRecord(DVRecord)
Adds new DVRecord to the collection.
Declaration
[CLSCompliant(false)]
public DataValidationImpl AddDVRecord(DVRecord dv)
Parameters
Type |
Name |
Description |
DVRecord |
dv |
DVRecord to add.
|
Returns
Exceptions
Type |
Condition |
System.ArgumentNullException |
If dv is NULL.
|
Clone(Object)
Declaration
public override object Clone(object parent)
Parameters
Type |
Name |
Description |
System.Object |
parent |
Parent object.
|
Returns
Type |
Description |
System.Object |
Returns new object.
|
Overrides
Syncfusion.XlsIO.Implementation.Collections.CollectionBaseEx<Syncfusion.XlsIO.Implementation.DataValidationImpl>.Clone(System.Object)
FindByCellIndex(Int64)
Returns data validation for specified cell.
Declaration
public DataValidationImpl FindByCellIndex(long cellIndex)
Parameters
Type |
Name |
Description |
System.Int64 |
cellIndex |
Cell index.
|
Returns
MarkUsedReferences(Boolean[])
Sets items with used reference indexes to true.
Declaration
public void MarkUsedReferences(bool[] usedItems)
Parameters
Type |
Name |
Description |
System.Boolean[] |
usedItems |
Array to mark used references in.
|
Remove(DataValidationImpl)
Declaration
public void Remove(DataValidationImpl dv)
Parameters
Remove(Rectangle[])
Declaration
public void Remove(Rectangle[] rectangles)
Parameters
Type |
Name |
Description |
System.Drawing.Rectangle[] |
rectangles |
|
Serialize(OffsetArrayList)
Saves collection into list of BiffRecords.
Declaration
[CLSCompliant(false)]
public void Serialize(OffsetArrayList records)
Parameters
Type |
Name |
Description |
OffsetArrayList |
records |
OffsetArrayList with BiffRecords.
|
Exceptions
Type |
Condition |
System.ArgumentNullException |
If records parameter is NULL.
|
UpdateNamedRangeIndexes(IDictionary<Int32, Int32>)
Updates indexes to named ranges.
Declaration
public void UpdateNamedRangeIndexes(IDictionary<int, int> dicNewIndex)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IDictionary<System.Int32, System.Int32> |
dicNewIndex |
New indexes.
|
UpdateNamedRangeIndexes(Int32[])
Updates indexes to named ranges.
Declaration
public void UpdateNamedRangeIndexes(int[] arrNewIndex)
Parameters
Type |
Name |
Description |
System.Int32[] |
arrNewIndex |
New indexes.
|
UpdateReferenceIndexes(Int32[])
Updates reference indexes.
Declaration
public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
Parameters
Type |
Name |
Description |
System.Int32[] |
arrUpdatedIndexes |
Array with updated indexes.
|
Implements
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable