IReferenceGetPageFilePath Method
|
Gets the specified page's file path. For design-time, this changes based on if the page is checked out,
who it is assigned to, and which version is marked for the current publishing target.
Namespace:
Ingeniux.Runtime.Reference
Assembly:
IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.6.308
Syntax string GetPageFilePath(
string pageId,
IPublishingTarget pubTgt = null,
bool isMofo = false,
bool useCheckedOutFile = false,
HttpRequestBase request = null
)
Function GetPageFilePath (
pageId As String,
Optional pubTgt As IPublishingTarget = Nothing,
Optional isMofo As Boolean = false,
Optional useCheckedOutFile As Boolean = false,
Optional request As HttpRequestBase = Nothing
) As String
String^ GetPageFilePath(
String^ pageId,
IPublishingTarget^ pubTgt = nullptr,
bool isMofo = false,
bool useCheckedOutFile = false,
HttpRequestBase^ request = nullptr
)
abstract GetPageFilePath :
pageId : string *
?pubTgt : IPublishingTarget *
?isMofo : bool *
?useCheckedOutFile : bool *
?request : HttpRequestBase
(* Defaults:
let _pubTgt = defaultArg pubTgt null
let _isMofo = defaultArg isMofo false
let _useCheckedOutFile = defaultArg useCheckedOutFile false
let _request = defaultArg request null
*)
-> string
Parameters
- pageId
- Type: SystemString
ID of the page to get the file path for - pubTgt (Optional)
- Type: IPublishingTarget
(Optional) The current publishing target. Null by default - isMofo (Optional)
- Type: SystemBoolean
(Optional) If publish is an MFO publish. False by defualt. - useCheckedOutFile (Optional)
- Type: SystemBoolean
(Optional) If checked out files should be used. If the page is assigned to the current user this will be overwritten to true. False by default. - request (Optional)
- Type: System.WebHttpRequestBase
(Optional) The HTTP request used to fetch the current user ID. Null by default.
Return Value
Type:
StringPhysical location of page file, or null if the page doesn't exist
See Also