Infragistics(R) NetAdvantage(R) Windows Forms
GetFullPath Method
See Also  E-mail your feedback on this topic.
Infragistics.Win.Misc Namespace > UltraNavigationBarLocation Class : GetFullPath Method

format
The FullPathFormat constant which defines the format of the returned path, i.e., whether the text of all ancestor locations should be unconditionally included in the returned value.
Returns a string which represents the full hierarchical path of this UltraNavigationBarLocation, optionally including all ancestor locations regardless of the value of the IncludeTextInFullPath property.

Syntax

Visual Basic (Declaration) 
Public Function GetFullPath( _
   ByVal format As FullPathFormat _
) As String
C# 
public string GetFullPath( 
   FullPathFormat format
)

Parameters

format
The FullPathFormat constant which defines the format of the returned path, i.e., whether the text of all ancestor locations should be unconditionally included in the returned value.

Return Value

A string which represents the full hierarchical path of this UltraNavigationBarLocation

Remarks

When the format parameter is set to 'EditMode', the IncludeTextInFullPath property is checked for ancestor locations before that ancestor's text is prepended to the value returned from the method. When the format parameter is set to 'AllAncestors', IncludeTextInFullPath is is not used, and the text for all ancestor locations is prepended to the returned value.

See Also