IPageLayoutControl.FindElementByName Method

Find the first element with the supplied name, supply an occurrence parameter to find the second, third and so on.

[Visual Basic .NET]
Public Function FindElementByName ( _
    ByVal Name As String, _
    [ByVal Occurence As Integer] _
) As IElement

[C#]
public IElement FindElementByName (
    string Name,
    int Occurence
);

[C++]
HRESULT FindElementByName(
  BSTR Name,
  long Occurence,
  IElement** element
);

[C++]
Parameters
Name [in]
  Name is a parameter of type BSTR
Occurence [in, optional, defaultvalue(1)]
  Occurence is a parameter of type long
element [out, retval]
  element is a parameter of type IElement

Product Availability

Description

If an empty string is supplied then any elements with no name are found. By default new elements are created with no name. To give an element a name so it can easily be found use one of the following methods: either supply a name string when using the AddElement method, or implement the IElementProperties interface.

See Also

IPageLayoutControl Interface | IPageLayoutControl.AddElement Method | IPageLayoutControl.LocateFrontElement Method