ComponentOne ASP.NET MVC Controls
LayoutItemCollection Class
File
c1.nav.js
Module
c1.nav
Base Class
ObservableArray

Defines the class which represents the collection of the layoutitems.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(parent?: any): LayoutItemCollection

Initializes a new LayoutItemCollection.

Parameters
Optional

The object owns this collection.

Returns
LayoutItemCollection

Properties

isUpdating

Gets a value that indicates whether notifications are currently suspended (see beginUpdate and endUpdate).

Inherited From
ObservableArray
Type

Methods

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
ObservableArray
Returns
void

clear

clear(): void

Removes all items from the array.

Inherited From
ObservableArray
Returns
void

deferUpdate

deferUpdate(fn: Function): void

Executes a function within a beginUpdate/endUpdate block.

The collection will not be refreshed until the function finishes. This method ensures endUpdate is called even if the function throws an exception.

Parameters
  • fn: Function

    Function to be executed without updates.

Inherited From
ObservableArray
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by a call to beginUpdate.

Inherited From
ObservableArray
Returns
void

implementsInterface

implementsInterface(interfaceName: string): boolean

Returns true if the caller queries for a supported interface.

Parameters
  • interfaceName: string

    Name of the interface to look for.

Inherited From
ObservableArray
Returns
boolean

indexOf

indexOf(searchElement: any, fromIndex?: number): number

Searches for an item in the array.

Parameters
  • searchElement: any

    Element to locate in the array.

  • fromIndex: number
Optional

The index where the search should start.

Inherited From
ObservableArray
Returns
number

insert

insert(index: number, item: any): void

Inserts an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

onCollectionChanged

onCollectionChanged(e?: NotifyCollectionChangedEventArgs): void

Raises the collectionChanged event.

Parameters
Optional

Contains a description of the change.

Returns
void

push

push(...item: any[]): number

Adds one or more items to the end of the array.

Parameters
Returns
number

remove

remove(item: any): boolean

Removes an item from the array.

Parameters
Inherited From
ObservableArray
Returns
boolean

removeAt

removeAt(index: number): void

Removes an item at a specific position in the array.

Parameters
Inherited From
ObservableArray
Returns
void

setAt

setAt(index: number, item: any): void

Assigns an item at a specific position in the array.

Parameters
Returns
void

slice

slice(begin?: number, end?: number): any[]

Creates a shallow copy of a portion of an array.

Parameters
Inherited From
ObservableArray
Returns
any[]

sort

sort(compareFn?: Function): this

Sorts the elements of the array in place.

Parameters
Inherited From
ObservableArray
Returns
this

splice

splice(index: number, count: number, item?: any): any[]

Removes and/or adds items to the array.

Parameters
Returns
any[]

Events

collectionChanged

Occurs when the collection changes.

Inherited From
ObservableArray
Arguments
NotifyCollectionChangedEventArgs