Jam.Shell.ViewSettings.TJamViewSettingsPropertyBag

Encapsulates a Windows Explorer like view state property bag and provides storing and loading of settings.

Syntax

Pascal

TJamViewSettingsPropertyBag = class(TJamCustomViewStatePropertyBag, IJamViewSettings);

Example

The following example shows how load the view state property bag of "C:" and read the stored icon size of the folder:

  var
    ViewStatePropertyBag: IJamViewSettings;
    IconSize: DWORD;

  begin
    ViewStatePropertyBag := TJamViewStatePropertyBag.Create;

    // Property bag of "C:" was opened successfully?
    if ViewStatePropertyBag.Open(TJamItemIdList.Create('C:')) then
      // Load settings
      IconSize := ViewStatePropertyBag.IconSize;
  end;

Namespace

Jam.Shell.ViewSettings

Public Methods

Jam.Shell.ViewSettings.TJamBaseViewSettings

	Name	Description
	constructor Create;	Constructor for creating a TJamDefaultViewSettings instance.

Jam.Shell.ViewSettings.TJamViewSettingsPropertyBag

	Name	Description
	constructor Create(const pPerSpecialFolder: Boolean = false);	Creates a new instance.

IJamViewSettings Methods

	Name	Description
	function GetFolderFlags: UINT;	Gets the folder flags.
	function GetGroupBy: TShellColumnId;	Gets the grouping.
	function GetGroupByAscending: Boolean;	Gets the direction of the grouping.
	function GetGroupView: Boolean;	Gets if the view uses grouping.
	function GetIconSize: DWORD;	Gets the icon size in pixels.
	function GetSortBy: TSortColumn;	Gets the sorting.
	function GetSortColumn: TShellColumnId;	Gets the shell column, the view is sorted by.
	function GetSortOrder: TJamSortDirection;	Gets the current sort direction.
	function GetViewMode: TJamViewMode;	Gets the view mode.
	function Open(const pFolderIdList: IItemIdList; const pName: string = ''): Boolean;	Opens the property bag for a specified folder.
	function ReadColumnInfo: TArray<TColumnInfo>;	Loads the stored column view states.
	procedure SetFolderFlags(const pFolderFlags: UINT);	Sets the folder flags.
	procedure SetGroupBy(const pGroupBy: TShellColumnId);	Sets the grouping.
	procedure SetGroupByAscending(const pAscending: Boolean);	Sets the direction of the grouping.
	procedure SetGroupView(const pGroupView: Boolean);	Sets if the view uses grouping.
	procedure SetIconSize(const pIconSize: DWORD);	Sets the icon size.
	procedure SetSortBy(const pSortBy: TSortColumn);	Sorts the view by a column.
	procedure SetSortColumn(const pValue: TShellColumnId);	Sets the shell column the view should be sorted by.
	procedure SetSortOrder(const pValue: TJamSortDirection);	Sets the current sort direction.
	procedure SetViewMode(const pViewMode: TJamViewMode);	Sets the view mode.
	procedure WriteColumnInfo(const pColumnViewStates: TArray<TColumnInfo>);	Stores the specified column view states.

Jam.Shell.ViewSettings.TJamBaseViewSettings

	Name	Description
	function Open(const pFolderIdList: IItemIdList; const pName: string = ''): Boolean; virtual;	Opens the property bag for a specified folder.
	function ReadColumnInfo: TArray<TColumnInfo>; virtual;	Loads the stored column view states.
	procedure WriteColumnInfo(const pColumnViewStates: TArray<TColumnInfo>); virtual;	Stores the specified column view states.

Jam.Shell.ViewSettings.TJamCustomViewStatePropertyBag

	Name	Description
	function Open(const pFolderIdList: IItemIdList; const pName: string = ''): Boolean; override; overload;	Opens the property bag for a specified folder.
	function Open(pLocation: TJamPropertyBagLocation; const pName: string = ''): Boolean; overload; reintroduce;	Opens the default property bag.

Jam.Shell.ViewSettings.TJamViewSettingsPropertyBag

	Name	Description
	function Open(const pFolderIdList: IItemIdList; const pName: string = ''): Boolean; override;	Opens the property bag for the passed pFolderIdList from the bag with the specified name.
	function ReadColumnInfo: TArray<TColumnInfo>; override;	Loads the stored column view states.
	procedure WriteColumnInfo(const pColumnViewStates: TArray<TColumnInfo>); override;	Stores the specified column view states.

IJamViewSettings Properties

	Name	Description
	property FolderFlags: UINT read GetFolderFlags write SetFolderFlags;	Gets or sets the folder flags.
	property GroupBy: TShellColumnId read GetGroupBy write SetGroupBy;	Gets or sets the grouping.
	property GroupByAscending: Boolean read GetGroupByAscending write SetGroupByAscending;	Gets or sets the grouping direction.
	property GroupView: Boolean read GetGroupView write SetGroupView;	Gets or sets if the view uses grouping.
	property IconSize: DWORD read GetIconSize write SetIconSize;	Gets or sets the icon size.
	property PrimarySortColumn: TShellColumnId read GetSortColumn write SetSortColumn;	Gets or sets the current sort column.
	property PrimarySortOrder: TJamSortDirection read GetSortOrder write SetSortOrder;	Gets or sets the current sort direction.
	property SortBy: TSortColumn read GetSortBy write SetSortBy;	Gets or sets the sorting.
	property ViewMode: TJamViewMode read GetViewMode write SetViewMode;	Gets or sets the view mode.

Jam.Shell.ViewSettings.TJamBaseViewSettings

	Name	Description
	property FolderIdList: IItemIdlist read fFolderIdList;	Gets the absolute ItemIdList of a folder to load or store the view settings.

Jam.Shell.ViewSettings.TJamCustomViewStatePropertyBag

	Name	Description
	property Name: string read fName;	Gets set name of the opened property bag.
	property ViewTemplate: TJamPropertyBagViewTemplate read fViewTemplate;	Gets the view template of the opened property bag.

Jam.Shell.ViewSettings.TJamViewSettingsPropertyBag

	Name	Description
	property PerSpecialFolder: Boolean read fPerSpecialFolder write fPerSpecialFolder;

Links

Jam.Shell.ViewSettings, Legend, Members, Public Methods, Example, IJamViewSettings Methods, IJamViewSettings Properties

Contents | Index | Home