Control.GetUniqueIDRelativeTo(Control) Method

Definition

Returns the prefixed portion of the UniqueID property of the specified control.

public:
 System::String ^ GetUniqueIDRelativeTo(System::Web::UI::Control ^ control);
public string GetUniqueIDRelativeTo (System.Web.UI.Control control);
member this.GetUniqueIDRelativeTo : System.Web.UI.Control -> string
Public Function GetUniqueIDRelativeTo (control As Control) As String

Parameters

control
Control

A control that is within a naming container.

Returns

The prefixed portion of the UniqueID property of the specified control.

Exceptions

The NamingContainer property of control is null.

control is null.

Remarks

The UniqueID property of a control is generated by adding a prefix to the control's ID property. The prefix is composed of the UniqueID property of the control's naming container concatenated with a separator character. If the naming container is the page, there is no prefix. This method returns the prefix string. If there is no prefix string, it returns the UniqueID value of the control.

Applies to