BookmarkFile Class¶
-
class
NXOpen.Gateway.
BookmarkFile
¶ Bases:
object
Represents operations which can be done on bookmark files.
To obtain an instance of this class, refer to
NXOpen.Session
New in version NX10.0.0.
Methods¶
Method | Description |
---|---|
Delete | Deletes an existing bookmark file. |
Rename | Renames an existing bookmark file. |
SaveWithDescription | Creates a bookmark file including a description. |
SetDescription | Changes the description of an existing bookmark file. |
Method Detail¶
Delete¶
-
BookmarkFile.
Delete
¶ Deletes an existing bookmark file.
Signature
Delete(pathName)
Parameters: pathName (str) – Full path name of existing bookmark file to delete New in version NX10.0.0.
License requirements: None.
Rename¶
-
BookmarkFile.
Rename
¶ Renames an existing bookmark file.
Signature
Rename(oldPathName, newFileName, okToOverwriteExistingFile)
Parameters: - oldPathName (str) – Full path name of existing bookmark file.
- newFileName (str) – New name to assign to the bookmark file. This will replace the basic name in the oldPathname.
- okToOverwriteExistingFile (bool) – Is it okay to overwrite an existing file with the same name as oldPathName plus newFileName?
Returns: Full path name to the renamed bookmark file.
This text string must be freed by the caller. :rtype: str
New in version NX10.0.0.
License requirements: None.
SaveWithDescription¶
-
BookmarkFile.
SaveWithDescription
¶ Creates a bookmark file including a description.
See
NXOpen.BasePartBookmarkOption
for an explanation of the options which are not supported in batch mode. Also in batch mode, the description is not written to the bookmark file.Signature
SaveWithDescription(pathName, bookmarkOption, description)
Parameters: - pathName (str) – Full path name of bookmark file.
- bookmarkOption (
NXOpen.BasePartBookmarkOption
) – See definitions ofNXOpen.BasePartBookmarkOption
- description (str) – A text string to be stored in the bookmark file
New in version NX10.0.0.
License requirements: None.
SetDescription¶
-
BookmarkFile.
SetDescription
¶ Changes the description of an existing bookmark file.
Otherwise the bookmark file is unchanged.
Signature
SetDescription(pathName, description)
Parameters: - pathName (str) – Full path name of an existing bookmark file.
- description (str) – A text string to replace the current description in the bookmark file
New in version NX10.0.0.
License requirements: None.