Type | Description | |||
Item as HITEM | A long expression that indicates the the handle of the item that hosts the bar. If the Item parameter is 0, it indicates all bars. In this case the DefaultItem property should be zero ( by default ), else it refers the item being indicated by DefaultItem (/COM version only) property. | |||
Key as Variant | A String expression that indicates the key of the bar being accessed. If missing, the Key parameter is empty. If the Item has only a single Bar you may not use the Key parameter, else an unique key should be used to allow multiple bars inside the item. The Key may include a pattern with wild characters as *,?,# or [], if the Key starts with "<" and ends on ">" aka "<K*>" which indicates all bars with the key K or starts on K. The pattern may include a space which divides multiple patterns for matching. For instance "<A* *K>" indicates all keys that start on A and all keys that end on K. | |||
Property as ItemBarPropertyEnum | An ItemBarPropertyEnum expression that indicates the property being accessed | |||
Variant | A Variant expression that indicates the property's value. |
Based on the values of the Item and Key parameters the ItemBar property changes a property for none, one or multiple bars as follows:
The pattern may include the space character which indicates multiple patterns to be used when matching. For instance "A* *K" indicates all keys that starts on A and all keys that ends on K. If not using a pattern, the ItemBar changes the property for specified key in all items if 0 is used for Item, or single Item if a valid handle is used on the Item parameter.
Here's few samples of using the set ItemBar property:
Currently, the single read-only property that supports pattern for the Key parameter is exBarsCount, which counts the bars as follows:
The pattern may include the space character which indicates multiple patterns to be used when matching. For instance "A* *K" indicates all keys that start on A and all keys that end on K. For any other property, the ItemBar property returns the bar's property for the first matching bar.
Here's few samples of using the get ItemBar(exBarsCount) property:
The /NET Assembly version defines get/set shortcut properties as follow ( they start with get_ or set_ keywords ):
For instance, You can use the get_BarColor property instead the get_ItemBar(exBarColor) property.
For instance, the following VB/NET sample changes the bar's color:
With Exg2antt1.Items .set_BarColor(.FocusItem, .get_FirstItemBar(.FocusItem), Color.Red) End With
The following VB sample changes the end date for the bar in the first visible item ( in this sample we consider that AddBar method was used with the Key parameter as being empty ) :
With G2antt1.Items .ItemBar(.FirstVisibleItem, "", exBarEnd) = "6/19/2005" End With
The following C++ sample changes the end date for the bar in the first visible item:
CItems items = m_g2antt.GetItems(); items.SetItemBar( items.GetFirstVisibleItem(), COleVariant(""), 2 /*exBarEnd*/, COleVariant("6/19/2005") );
The following VB.NET sample changes the end date for the bar in the first visible item:
With AxG2antt1.Items .ItemBar(.FirstVisibleItem, "", EXG2ANTTLib.ItemBarPropertyEnum.exBarEnd) = "6/19/2005" End With
The following C# sample changes the end date for the bar in the first visible item:
axG2antt1.Items.set_ItemBar(axG2antt1.Items.FirstVisibleItem, "", EXG2ANTTLib.ItemBarPropertyEnum.exBarEnd, "6/19/2005");
The following VFP sample changes the end date for the bar in the first visible item:
with thisform.G2antt1.Items .DefaultItem = .FirstVisibleItem thisform.G2antt1.Template = "Items.ItemBar(0,`" + _key + "`,2 ) = `20/07/2005`" endwith
where the _key is the key of the bar being resized.
The VFP sample uses the Template property in order to execute the ItemBar property, else some version of VFP could fire "Function argument, value, type, or count is invalid". The sample builds the script:
Items.ItemBar(0,_key,2) = `20/07/2005`
This way the ItemBar property for the default item is invoked.