IPanes​.ItemByName [Property][Get]

Returns a reference to the pane object with the given name from this Panes collection.

Defined As

• [VBA] ByName(name As String) as Object

• [Cicode] OBJECT ByName(STRING name)

• [C++] ByName(STRING name, IPane* Item)

Parameters

name

[in] Indicates the name of the Pane item to return from this collection.

Execution Result

If the property get succeeds, the return value will be Success. If the pane cannot be found, the return value will be InvalidArgument. If the panes collection is deleted, the return value will be GeneralFailure.

Calling Syntax

This example assumes there is a valid Panes collection object to be passed into the example methods.

[VBA]

Sub Example(Panes As Object)
Dim pane As Object
`Getting Property value
Set pane = Panes.ItemByName("Alarm Pane")
End Sub

[Cicode]

FUNCTION Example(OBJECT hPanes)
// Getting property value
OBJECT hPane = _ObjectCallMethod(hPanes, "get_ItemByName", "Alarm Pane");
END