Back to Devexpress

TdxPSFileBasedExplorer Members

vcl-dxpsfilebasedxplorer-dot-tdxpsfilebasedexplorer-dot-underscore-members.md

latest19.2 KB
Original Source

TdxPSFileBasedExplorer Members

Provides functionality to explore report documents stored at a particular path.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
ActiveFolder
ActiveFolderPath
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
DesignInfoInherited from TComponent.
FilterLinkSpecifies the class of links whose reports are displayed by the explorer. Inherited from TCustomdxPSExplorer.
FilterLinkClassSpecifies the class of links whose reports are displayed by the explorer. Inherited from TCustomdxPSExplorer.
FilterLinkClassNameInherited from TCustomdxPSExplorer.
NameInherited from TComponent.
ObserversInherited from TComponent.
OptionsSpecifies a file-based report explorer’s options.
OwnerInherited from TComponent.
RealRootPathReturns the actual root path.
RootReturns an object representing the root folder.
RootPathSpecifies the root path.
StateReturns the explorer’s current state. Inherited from TCustomdxPSExplorer.
TagInherited from TComponent.
VCLComObjectInherited from TComponent.

Methods

NameDescription
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject)Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject)Inherited from TComponent.
BeginInvoke(TProc,TObject)Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject)Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject)Inherited from TComponent.
BuildTree(TCustomdxPSExplorerTreeContainer)Builds the report tree using the specified tree container. Inherited from TCustomdxPSExplorer.
CanCreateFolderIndicates whether the explorer can create folders. Inherited from TCustomdxPSExplorer.
CanCreateItemIndicates whether the explorer can create report items. Inherited from TCustomdxPSExplorer.
CanGoToUpOneLevelDetermines whether the explorer can change its root path to make it one level higher.
CanSetActiveFolderAsRoot
CreateNewFolder(TdxPSExplorerFolder)Creates a new folder within the specified parent folder. Inherited from TCustomdxPSExplorer.
CreateNewItem(TdxPSExplorerFolder,TBasedxReportLink)Saves the specified report to the specified folder. Inherited from TCustomdxPSExplorer.
CreateTree(IdxPSExplorerTreeContainerHost)Creates the report tree container. Inherited from TCustomdxPSExplorer.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
FileExtensionReturns the report file extension.
FindComponent(String)Inherited from TComponent.
FindCustomItemByUniqueID(TBytes)Returns the folder or item by its unique ID. Inherited from TCustomdxPSExplorer.
FindFolderByFullQualifiedDirName(string)Returns an object representing the folder specified by its full-qualified name.
FindItemByFullQualifiedFileName(string)Returns an object representing the report item specified by the full-qualified file name.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetHashCodeInherited from TObject.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GoToUpOneLevelSwitches the explorer’s root folder one level higher.
HasParentInherited from TComponent.
InsertComponent(TComponent)Inherited from TComponent.
IsImplementorOf(IInterface)Inherited from TComponent.
LoadedInherited from TComponent.
LoadedItemReturns an object representing the report item whose content is currently displayed.
LoadFromIniFile(TCustomIniFile,string)
LoadFromIniFile(string)Loads the explorer’s settings from an INI file.
LoadFromRegistry(string)Loads the explorer’s settings from the registry.
LoadItemData(TdxPSExplorerItem,TBasedxReportLink)Loads a particular item’s data into a report link. Inherited from TCustomdxPSExplorer.
LoadItemData(string,TBasedxReportLink)Loads a particular item’s data into a report link.
Notification(TComponent,TOperation)Inherited from TComponent.
PopulatePath(string)Populates the folder specified by its full-qualified path.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RefreshUpdates the report explorer. Inherited from TCustomdxPSExplorer.
RegisterNotifier(TdxPSExplorerChangeNotifier)Registers the specified change notifier. Inherited from TCustomdxPSExplorer.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
SaveToIniFile(TCustomIniFile,string)
SaveToIniFile(string)Saves the explorer’s settings to an INI file.
SaveToRegistry(string)Saves the explorer’s settings to the specified path within the registry.
SetActiveFolderAsRoot
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ShowChangeRootPathDlgDisplays the dialog that enables end-users to change the root path.
ToStringInherited from TObject.
UnloadItemData(TdxPSExplorerItem)Unloads an item’s data from a report link. Inherited from TCustomdxPSExplorer.
UnloadItemData(string)Unloads an items data from a particular report link.
UnregisterNotifier(TdxPSExplorerChangeNotifier)Removes the specified notifier from the registered notifiers list. Inherited from TCustomdxPSExplorer.
UpdateAction(TBasicAction)Inherited from TComponent.

Events

NameDescription
OnItemDataLoadErrorFires when data loading errors occur. Inherited from TCustomdxPSExplorer.
OnLoadErrorFires when a folder or item loading error occurs.

See Also

TdxPSFileBasedExplorer Class

dxPSFileBasedXplorer Unit