PopupFolderFilterDialog Method
- Last UpdatedNov 06, 2025
- 2 minute read
The PopupFolderFilterDialog() method opens the Folder's Filter dialog. If the user applies a filter, the values for the filters are returned in the supplied variables. If the user does not apply the filter, the supplied variables are not changed.
'Declaration
Public Shared Function PopupFolderFilterDialog( _
ByRef itemClassID As String, _
ByRef itemClassDesc As String, _
ByRef itemID As String, _
ByRef itemDesc As String, _
ByRef operID As String, _
ByRef operDesc As String, _
ByRef entityID As String, _
ByRef verID As String, _
ByRef udf1 As String, _
ByRef udf2 As String, _
ByRef file As String, _
ByRef includeAncestors As Boolean, _
ByVal restrictEntAccess As Boolean, _
ByVal hideCancelButton As Boolean _
) As Boolean
public static bool PopupFolderFilterDialog(
ref string itemClassID,
ref string itemClassDesc,
ref string itemID,
ref string itemDesc,
ref string operID,
ref string operDesc,
ref string entityID,
ref string verID,
ref string udf1,
ref string udf2,
ref string file,
ref bool includeAncestors,
bool restrictEntAccess,
bool hideCancelButton
)
Parameters
- itemClassID
- Optional. Output. Holds the value of the item Class ID filter.
- itemClassDesc
- Optional. Output. Holds the value of the item class description filter.
- itemID
- Optional. Output. Holds the value of the item ID filter.
- itemDesc
- Optional. Output. Holds the value of the item description filter.
- operID
- Optional. Output. Holds the value of the operation ID filter.
- operDesc
- Optional. Output. Holds the value of the operation description filter.
- entityID
- Optional. Output. Holds the value of the entity ID filter.
- verID
- Optional. Output. Holds the value of the version ID filter.
- udf1
- Optional. Output. Holds the value of the first user-defined filter.
- udf2
- Optional. Output. Holds the value of the second user-defined field filter.
- file
- Optional. Output. Holds the value of the file filter.
- includeAncestors
- Optional. Output. Holds the value of the include ancestor filter.
- restrictEntAccess
- Optional. Output. Holds a flag that, if set to true, specifies that access to the entity filter should be restricted based on the user's ability to override entities.
- hideCancelButton
- Optional. Output. Holds a flag that, if set to true, specifies that the Cancel button be hidden or, if set to false, that the Cancel button be shown.
Return Value
Returns true if the user applied the filter and false if the user did not apply the filter.