Represents the JournalManager which is used to query data about journals when recording and replaying journal files. More...
Classes | |
| struct | _PlayDotNetJournalInformation |
| This structure contains information from playing the DotNet Journal. | |
| struct | PlayDotNetJournalInformation |
| This structure contains information from playing the DotNet Journal. More... | |
Public Member Functions | |
| unsafe void | InsertUserDefinedCode (string userDefinedCode) |
| Inserts the passed in string into a journal. More... | |
| unsafe void | InsertComment (string comment) |
| Inserts string as a comment into the journal. More... | |
| unsafe NXOpen.JournalManager.PlayDotNetJournalInformation | PlayDotNetJournal (string filename, string[] arguments) |
| Play a journal .Net journal file. More... | |
| unsafe void | RecordJournal (string filename) |
| Start recording a journal file. More... | |
| unsafe void | StopRecordingJournal () |
| Stops Recording a journal file. More... | |
Properties | |
| Tag | Tag [get] |
| Returns the tag of this object. More... | |
| unsafe bool | IsJournalRecording [get] |
| Returns the flag indicating if a Journal is recording. More... | |
| unsafe bool | IsJournalRunning [get] |
| Returns the flag indicating if a Journal is replaying inside of NX. More... | |
| unsafe NXOpen.Preferences.SessionUserInterface.JournalLanguageType | JournalLanguage [get] |
| Returns the language the journal will be recored in. More... | |
| unsafe bool | PauseJournal [get, set] |
| Returns or sets the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal. More... | |
| unsafe bool | PauseJournalingOfBlockStylerCalls [get, set] |
| Returns or sets the flag to indicate if Blockstyler journal calls should be paused. More... | |
Detailed Description
Represents the JournalManager which is used to query data about journals when recording and replaying journal files.
The language NX is setup to, or currently recording can be determined from NXOpen.Preferences.SessionUserInterface.JournalLanguage .
To obtain an instance of this class, refer to NXOpen.Session
Created in NX11.0.0
Member Function Documentation
| unsafe void NXOpen.JournalManager.InsertComment | ( | string | comment | ) |
Inserts string as a comment into the journal.
The comment with appropriate markups for the language being recorded so it will be a comment. If this is called when not journaling, this method does nothing.
Created in NX11.0.0
License requirements: None.
- Parameters
-
comment comment to be inserted into the journal
| unsafe void NXOpen.JournalManager.InsertUserDefinedCode | ( | string | userDefinedCode | ) |
Inserts the passed in string into a journal.
If this is called when not journaling, this method does nothing.
Created in NX11.0.0
License requirements: None.
- Parameters
-
userDefinedCode user defined code to be inserted into the journal
| unsafe NXOpen.JournalManager.PlayDotNetJournalInformation NXOpen.JournalManager.PlayDotNetJournal | ( | string | filename, |
| string[] | arguments | ||
| ) |
Play a journal .Net journal file.
Only .Net files are allowed to played. If arguments are passed in and the journal file main symbol does not have a signature to accept arguments, an exception will be thrown.
This method may not be nested (for example a journal uses this method to call a journal which calls this method to run another journal file). The nested limit is one.
Created in NX11.0.0
License requirements: dotnet_author (".NET API Author")
- Parameters
-
filename path to VB or C# file. arguments string arguments to be passed to journal file
- Returns
- Struct that contains the information from the running of the DotNet journal.
| unsafe void NXOpen.JournalManager.RecordJournal | ( | string | filename | ) |
Start recording a journal file.
This will record a journal file in the language specified by NXOpen.Preferences.SessionUserInterface.JournalLanguage . The proper exentsion will be added based upon the preference.
An error will be thrown if a journal is already recording.
Created in NX11.0.0
License requirements: dotnet_author (".NET API Author")
- Parameters
-
filename path to record journal file. The extension will be added automatically based upon the preferences.
| unsafe void NXOpen.JournalManager.StopRecordingJournal | ( | ) |
Stops Recording a journal file.
An error will be thrown if this is called and NX is not currently recording.
Created in NX11.0.0
License requirements: dotnet_author (".NET API Author")
Property Documentation
|
get |
Returns the flag indicating if a Journal is recording.
If true, a journal is recording.
Created in NX11.0.0
License requirements: None.
|
get |
Returns the flag indicating if a Journal is replaying inside of NX.
If true, a journal is running. This will only return true if we are replaying a journal using the Play Journal dialog inside a NX interactive session. This will be limited to only VB, C#, and Python journals replaying.
Created in NX11.0.0
License requirements: None.
|
get |
Returns the language the journal will be recored in.
This is a convenience querry, as this will return the same value as NXOpen.Preferences.SessionUserInterface.JournalLanguage
Created in NX11.0.0
License requirements: None.
|
getset |
Returns or sets the flag to indicate if journal calls should be paused Pauses/UnPauses recording of calls to journal.
When this method is called from journal file playing, the pause will end automatically after it it is done replaying. This is true if the journal is run inside of NX using the Play Journal functionality or using the methods NXOpen.JournalManager.PlayDotNetJournal or NXOpen.JournalManager.PlayPythonJournal called from the executing journal. In other words, if you start recording a journal, and then play a journal (through Play Journal Dialog or method call) which calls this method. The journal will be only paused while it is playing, and then once that journal is done playing journaling will resume.
When this method is called from a NXOpen DLL it will persist after DLL is run or has returned control to NX for those programs that are not immediately unloaded after running. This can have an impact on Redo if this DLL is run outside of Journal record scenario.
Created in NX11.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the flag to indicate if Blockstyler journal calls should be paused.
If true BlockStyler calls will not be recorded to the journal. When this method is called from journal file playing, the pause will end automatically after it it is done replaying. This is true if the journal is run inside of NX using the Play Journal functionality or using the methods NXOpen.JournalManager.PlayDotNetJournal or NXOpen.JournalManager.PlayPythonJournal called from the executing journal. In other words, if you start recording a journal, and then play a journal (through Play Journal Dialog or method call) which calls this method. The journal will be only paused while it is playing, and then once that journal is done playing journaling will resume.
When this method is called from a NXOpen DLL it will persist after DLL is run or has returned control to NX for those programs that are not immediately unloaded after running. This can have an impact on Redo if this DLL is run outside of Journal record scenario.
Created in NX11.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- dotnet_pool/JournalManager.cs