Class GeocodingTableReferenceCollection

Represents a collection of geocoding tables as data table references or library item references.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Context Count IsAttached Transactions Add Clear GetEnumerator Remove

Extended capability 'LibraryRead'

Add Remove

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

[iterator]

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

ReadonlyItem

Item: PropertyGet<number | Int32, GeocodingTableReference>

Gets the element at the specified index.

Param: index

The zero-based index of the element to get or set.

Returns

The element at the specified index.

Since

2.0

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Count

  • get Count(): number

  • Gets the number of elements contained in the collection.

    Returns number

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

Add

  • Add(dataTable): void

  • Adds a data table to the collection.

    Parameters

    • dataTable: DataTable

      The data table to add to this collection.

    Returns void

    Since

    2.0

  • Add(libraryItem): void

  • Adds the specified library item to this collection.

    Parameters

    Returns void

    Since

    2.0

  • Add(dataTable, libraryItem): void

  • Adds a data table to this collection.

    Parameters

    • dataTable: DataTable

      The data table to add to this collection.

    • libraryItem: LibraryItem

      The corresponding library item that the data table was loaded from.

    Returns void

    Since

    2.0

Clear

  • Clear(): void

  • Removes all items from the collection.

    Returns void

    Since

    2.0

GetEnumerator

Remove

  • Remove(dataTable): boolean

  • Removes the specified data table from this collection.

    Parameters

    • dataTable: DataTable

      The data table to remove from this collection.

    Returns boolean

    true if dataTable was successfully removed from this collection, otherwise false. This method also returns false if dataTable is not found in the original collection.

    Since

    2.0

  • Remove(libraryItem): boolean

  • Removes the specified library item from this collection.

    Parameters

    • libraryItem: LibraryItem

      The library item to remove from the collection.

    Returns boolean

    true if libraryItem was successfully removed from the collection, otherwise false. This method also returns false if libraryItem is not found in the original collection.

    Since

    2.0

Extended capability 'LibraryRead'

Add

  • Add(dataTable): void

  • Adds a data table to the collection.

    Parameters

    • dataTable: DataTable

      The data table to add to this collection.

    Returns void

    Since

    2.0

  • Add(libraryItem): void

  • Adds the specified library item to this collection.

    Parameters

    Returns void

    Since

    2.0

  • Add(dataTable, libraryItem): void

  • Adds a data table to this collection.

    Parameters

    • dataTable: DataTable

      The data table to add to this collection.

    • libraryItem: LibraryItem

      The corresponding library item that the data table was loaded from.

    Returns void

    Since

    2.0

Remove

  • Remove(dataTable): boolean

  • Removes the specified data table from this collection.

    Parameters

    • dataTable: DataTable

      The data table to remove from this collection.

    Returns boolean

    true if dataTable was successfully removed from this collection, otherwise false. This method also returns false if dataTable is not found in the original collection.

    Since

    2.0

  • Remove(libraryItem): boolean

  • Removes the specified library item from this collection.

    Parameters

    • libraryItem: LibraryItem

      The library item to remove from the collection.

    Returns boolean

    true if libraryItem was successfully removed from the collection, otherwise false. This method also returns false if libraryItem is not found in the original collection.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
Extended capability 'LibraryRead'