Items Object (ExG2antt) | Exontrol Docs

Items object

The Items object contains a collection of items. Each item is identified by a handle HITEM. The HITEM is of long type. Each item contains a collection of cells. The number of cells is determined by the number of Column objects in the control. To access the Items collection use Items property of the control. Using the Items collection you can add, remove or change the control items. The Items collection can be organized as a hierarchy or as a tabular data.

The following screen shot shows the items of the control:

The Items collection supports the following properties and methods:

		Name	Description
		AcceptSetParent	Retrieves a value indicating whether the SetParent method can be accomplished..
		AddBar	Adds a bar to an item.
		AddItem	Adds a new item, and returns a handle to the newly created item.
		AddLink	Links a bar to another.
		AllowCellValueToItemBar	Retrieves or sets a value that indicates whether the cells display associated properties of the bars in the item.
		CellBackColor	Retrieves or sets the cell's background color.
		CellBold	Retrieves or sets a value that indicates whether the cell's caption should appear in bold.
		CellButtonAutoWidth	Retrieves or sets a value indicating whether the cell's button fits the cell's caption.
		CellCaption	Gets the cell's display value.
		CellChecked	Retrieves the cell's handle that is checked on a specific radio group.
		CellData	Retrieves or sets the extra data for a specific cell.
		CellEditor	Creates and gets the cell's built-in editor.
		CellEditorVisible	Specifies whether column's editor is visible or hidden in the cell.
		CellEnabled	Returns or sets a value that determines whether a cell can respond to user-generated events.
		CellFont	Retrieves or sets the cell's font.
		CellForeColor	Retrieves or sets the cell's foreground color.
		CellFormatLevel	Specifies the arrangement of the fields inside the cell.
		CellHAlignment	Retrieves or sets a value that indicates the alignment of the cell's caption.
		CellHasButton	Retrieves or sets a value indicating whether the cell has associated a push button or not.
		CellHasCheckBox	Retrieves or sets a value indicating whether the cell has associated a checkbox or not.
		CellHasRadioButton	Retrieves or sets a value indicating whether the cell has associated a radio button or not.
		CellHyperLink	Specifies whether the cell's is highlighted when the cursor mouse is over the cell.
		CellImage	Retrieves or sets an Image that is displayed on the cell's area.
		CellImages	Specifies an additional list of icons shown in the cell.
		CellItalic	Retrieves or sets a value that indicates whether the cell's caption should appear in italic.
		CellItem	Retrieves the handle of item that is the owner of a specific cell.
		CellMerge	Retrieves or sets a value that indicates the index of the cell that's merged to.
		CellParent	Retrieves the parent of an inner cell.
		CellPicture	Retrieves or sets a value that indicates the Picture object displayed by the cell.
		CellPictureHeight	Retrieves or sets a value that indicates the height of the cell's picture.
		CellPictureWidth	Retrieves or sets a value that indicates the width of the cell's picture.
		CellRadioGroup	Retrieves or sets a value indicating the radio group where the cell is contained.
		CellSingleLine	Retrieves or sets a value indicating whether the cell's caption is painted using one or more lines.
		CellState	Retrieves or sets the cell's state. Has effect only for check and radio cells.
		CellStrikeOut	Retrieves or sets a value that indicates whether the cell's caption should appear in strikeout.
		CellToolTip	Retrieves or sets a text that is used to show the tooltip's cell.
		CellUnderline	Retrieves or sets a value that indicates whether the cell's caption should appear in underline.
		CellVAlignment	Retrieves or sets a value that indicates how the cell's caption is vertically aligned.
		CellValue	Specifies the cell's value.
		CellValueFormat	Specifies how the cell's caption is displayed.
		CellValueToItemBar	Indicates whether the cell displays the specified property of the bar.
		CellWidth	Retrieves or sets a value that indicates the width of the inner cell.
		ChildCount	Retrieves the number of children items.
		ClearBars	Clears the bars from the item.
		ClearCellBackColor	Clears the cell's background color.
		ClearCellForeColor	Clears the cell's foreground color.
		ClearCellHAlignment	Clears the cell's alignment.
		ClearItemBackColor	Clears the item's background color.
		ClearItemForeColor	Clears the item's foreground color.
		ClearLinks	Clears all links in the chart.
		ComputeValue	Computes the value of a specified formula.
		DefaultItem	Retrieves or sets the default item.
		DefineSummaryBars	Defines the bars that belongs to a summary bar.
		DefSchedulePDM	Retrieves or sets an option for SchedulePDM method.
		DeleteCellEditor	Deletes the cell's built-in editor created by CellEditor property.
		EnableItem	Returns or sets a value that determines whether a item can respond to user-generated events.
		EndBlockUndoRedo	Ends recording the UI operations and adds the undo/redo operations as a block, so they all can be restored at once, if Undo method is performed.
		EndUpdateBar	Adds programmatically updated properties of the bar to undo/redo queue.
		EndUpdateLink	Adds programmatically updated properties of the link to undo/redo queue.
		EnsureVisibleBar	Ensures that the given item-bar fits the chart's visible area.
		EnsureVisibleItem	Ensures that the given item fits the control's visible area
		ExpandItem	Expands, or collapses, the child items of the specified item.
		FindBar	Finds the item that hosts the specified bar.
		FindItem	Finds an item, looking for Caption in ColIndex colum. The searching starts at StartIndex item.
		FindItemData	Finds the item giving its data.
		FindPath	Finds the item, given its path. The control searches the path on the SearchColumnIndex column.
		FirstItemBar	Gets the key of the first bar in the item.
		FirstLink	Gets the key of the first link.
		FirstVisibleItem	Retrieves the handle of the first visible item into control.
		FocusItem	Retrieves the handle of item that has the focus.
		FormatCell	Specifies the custom format to display the cell's content.
		FullPath	Returns the fully qualified path of the referenced item in the control. The caption is taken from the column SearchColumnIndex.
		GroupBars	Groups two bars.
		GroupItem	Indicates a group item if positive, and the value specifies the index of the column that has been grouped.
		HasCellEditor	Specifies whether a cell has a built-in editor.
		HoistItem	Gets or sets the handle of the hoisted item, promoting it and all its visible children to the top level without altering their content or properties.
		InnerCell	Retrieves the inner cell.
		InsertControlItem	Inserts a new item of ActiveX type, and returns a handle to the newly created item.
		InsertItem	Inserts a new item, and returns a handle to the newly created item.
		IntersectBars	Specifies whether two bars intersect if returns 0, if 1 A is before B and -1 if A is after bar B.
		IsItemLocked	Returns a value that indicates whether the item is locked or unlocked.
		IsItemVisible	Checks if the specific item is in the visible client area.
		ItemAllowSizing	Retrieves or sets a value that indicates whether a user can resize the item at run-time.
		ItemAppearance	Specifies the item's appearance when the item hosts an ActiveX control.
		ItemBackColor	Retrieves or sets a background color for a specific item.
		ItemBar	Gets or sets a bar property.
		ItemBarEx	Gets or sets the property's bar that matches the criteria.
		ItemBold	Retrieves or sets a value that indicates whether the item should appear in bold.
		ItemByIndex	Retrieves the handle of the item given its index in Items collection..
		ItemCell	Retrieves the cell's handle based on a specific column.
		ItemChild	Retrieves the child of a specified item.
		ItemControlID	Retrieves the item's control identifier that was used by InsertControlItem.
		ItemCount	Retrieves the number of items.
		ItemData	Retrieves or sets the extra data for a specific item.
		ItemDivider	Specifies whether the item acts like a divider item. The value indicates the index of column used to define the divider's title.
		ItemDividerLine	Defines the type of line in the divider item.
		ItemDividerLineAlignment	Specifies the alignment of the line in the divider item.
		ItemFiltered	Checks whether the item is included in the control's filter.
		ItemFont	Retrieves or sets the item's font.
		ItemForeColor	Retrieves or sets a foreground color for a specific item.
		ItemHasChildren	Adds an expand button to left side of the item even if the item has no child items.
		ItemHeight	Retrieves or sets the item's height.
		ItemItalic	Retrieves or sets a value that indicates whether the item should appear in italic.
		ItemMaxHeight	Retrieves or sets a value that indicates the maximum height when the item's height is variable.
		ItemMinHeight	Retrieves or sets a value that indicates the minimum height when the item's height is sizing.
		ItemNonworkingUnits	Gets or sets a value that indicates the formula to specify the use non-working units for the item.
		ItemObject	Retrieves the ActiveX object associated, if the item was created using InsertControlItem method.
		ItemParent	Returns the handle of parent item.
		ItemPosition	Retrieves or sets a value that indicates the item's position in the children list.
		ItemStrikeOut	Retrieves or sets a value that indicates whether the item should appear in strikeout.
		ItemToIndex	Retrieves the index of item into Items collection given its handle.
		ItemUnderline	Retrieves or sets a value that indicates whether the item should appear in underline.
		ItemWidth	Retrieves or sets a value that indicates the item's width while it contains an ActiveX control.
		ItemWindowHost	Retrieves the window's handle that hosts an ActiveX control when the item was created using InsertControlItem.
		ItemWindowHostCreateStyle	Retrieves or sets a value that indicates a combination of window styles used to create the ActiveX window host.
		LastVisibleItem	Retrieves the handle of the last visible item.
		Link	Gets or sets a property for a link.
		LockedItem	Retrieves the handle of the locked/fixed item.
		LockedItemCount	Specifies the number of items fixed on the top or bottom side of the control.
		LockItem	Enables setting or getting the item's lock state - pinning it to the top, bottom, or allowing it to scroll.
		MatchItemCount	Retrieves the number of items that match the filter.
		MergeCells	Merges a list of cells.
		NextItemBar	Gets the key of the next bar in the item.
		NextLink	Gets the key of the next link.
		NextSiblingItem	Retrieves the next sibling of the item in the parent's child list.
		NextVisibleItem	Retrieves the handle of next visible item.
		PathSeparator	Returns or sets the delimiter character used for the path returned by the FullPath property.
		PrevSiblingItem	Retrieves the previous sibling of the item in the parent's child list.
		PrevVisibleItem	Retrieves the handle of previous visible item.
		RemoveAllItems	Removes all items from the control.
		RemoveBar	Removes a bar from an item.
		RemoveItem	Removes a specific item.
		RemoveLink	Removes a link.
		RemoveLinksOf	Removes the links that goes or ends on the specified bar.
		RemoveSelection	Removes the selected items (including the descendents).
		RootCount	Retrieves the number of root objects into Items collection.
		RootItem	Retrieves the handle of the root item giving its index into the root items collection.
		SchedulePDM	Schedules the chart using the Precedence Diagram Method.
		SelectableItem	Specifies whether the user can select the item.
		SelectAll	Selects all items.
		SelectCount	Retrieves the handle of selected item giving its index in selected items collection.
		SelectedItem	Retrieves the selected item's handle given its index in selected items collection.
		SelectedObjects	Retrieves a collection of selected objects in the chart.
		SelectItem	Selects or unselects a specific item.
		SelectPos	Selects items by position.
		SetParent	Changes the parent of the given item.
		SortableItem	Specifies whether the item is sortable.
		SortChildren	Sorts the child items of the given parent item in the control. SortChildren will not recurse through the tree, only the immediate children of Item will be sorted.
		SplitCell	Splits a cell, and returns the inner created cell.
		StartBlockUndoRedo	Starts recording the UI operations as a block of undo/redo operations.
		StartUpdateBar	Starts changing properties of the bar, so EndUpdateBar method adds programmatically updated properties to undo/redo queue.
		StartUpdateLink	Starts changing properties of the link, so EndUpdateLink method adds programmatically updated properties to undo/redo queue.
		UndefineSummaryBars	Undefines the bars in a summary bar
		UngroupBars	Ungroups two bars.
		UnmergeCells	Unmerges a list of cells.
		UnselectAll	Unselects all items.
		UnsplitCell	Unsplits a cell.
		VisibleCount	Retrieves the number of visible items.
		VisibleItemCount	Retrieves the number of visible items.