ItemIdListGetPropertyDisplayValue Method

Gets property value converted to a string.

Namespace: Jam.Shell
Assembly: ShellBrowser.Core (in ShellBrowser.Core.dll) Version: 6.3.1

Syntax

public string GetPropertyDisplayValue(
	SHCOLUMNID pShellColumnId
)

Public Function GetPropertyDisplayValue ( 
	pShellColumnId As SHCOLUMNID
) As String

public:
String^ GetPropertyDisplayValue(
	SHCOLUMNID pShellColumnId
)

member GetPropertyDisplayValue : 
        pShellColumnId : SHCOLUMNID -> string

Parameters

pShellColumnId: Type: Jam.ShellSHCOLUMNID
Identifier for the property.

Return Value

Type: String
The formatted property value or an empty string if the property doesn't have a value or is not supported by the item.

Remarks

Only works on Vista and higher. The value is converted using Shell API function FormatForDisplay, so it returns the same string Windows Explorer is displaying.

Examples

Retrieve the search scope of an ItemIdList representing a SearchFolder as path.

Copy

//Gets the search scope of an ItemIdList representing a SearchFolder, i.e. the folder the search was started in.
// as ItemIdList
ItemIdList searchScope = itemIdList1.GetPropertyVariantValue(SHCOLUMNID.SearchScope) as ItemIdList;
// as path
string searchScopePath = itemIdList1.GetPropertyDisplayValue(SHCOLUMNID.SearchScope);

Reference

ItemIdList Class

Jam.Shell Namespace

ItemIdListAddLanguageSpecificTextSet("LSTA09838B_0?cpp=::|nu=.");GetPropertyDisplayValue Method

Parameters

Return Value

Reference

ItemIdListGetPropertyDisplayValue Method