FrameworkContentElement.FindName(String) Method

Definition

Finds an element that has the provided identifier name.

public:
 System::Object ^ FindName(System::String ^ name);
public object FindName (string name);
member this.FindName : string -> obj
Public Function FindName (name As String) As Object

Parameters

name
String

Name of the element to search for.

Returns

Object

The requested element. May be null if no matching element was found.

Examples

The following example sets a property on an element found by name within a referenced FlowDocument on a page.

void HighlightParagraph(string paraName)
{
    try
    {
        Paragraph wantedNode = (Paragraph)myflowdocument.FindName(paraName);
        if (wantedNode != null)
        {
            wantedNode.Background = Brushes.LightYellow;
        }
    }
    catch { }//handle paragraph not found in UI }
}
Private Sub HighlightParagraph(ByVal paraName As String)
    Try
        Dim wantedNode As Paragraph = CType(myflowdocument.FindName(paraName), Paragraph)
        If wantedNode IsNot Nothing Then
            wantedNode.Background = Brushes.LightYellow
        End If
    Catch 'handle paragraph not found in UI }
    End Try
End Sub

Remarks

If this element has child elements, these child elements are all searched recursively for the requested named element.

Applies to