DocumentSetActiveSegmentPair Method (ProjectFile, String) |
Sets the active segment pair to the segment pair with the given number.
Namespace: Sdl.TranslationStudioAutomation.IntegrationApiAssembly: Sdl.TranslationStudioAutomation.IntegrationApi (in Sdl.TranslationStudioAutomation.IntegrationApi.dll) Version: 4.2.0.0 (4.1.5799.0)
Syntax public bool SetActiveSegmentPair(
ProjectFile projectFile,
string segmentNumber
)
Public Function SetActiveSegmentPair (
projectFile As ProjectFile,
segmentNumber As String
) As Boolean
public:
bool SetActiveSegmentPair(
ProjectFile^ projectFile,
String^ segmentNumber
)
member SetActiveSegmentPair :
projectFile : ProjectFile *
segmentNumber : string -> bool
Parameters
- projectFile
- Type: Sdl.ProjectAutomation.CoreProjectFile
For normal document it is opened from one file and for virtual document it is opened from multiple files.
When the document is virtual the projetFile indicates the refered file, which can be obtained from Files properpty of Document.
For normal document, this parameter is ignored. - segmentNumber
- Type: SystemString
The segment number.
Return Value
Type:
BooleanTrue if the segment pair was activated successfully.
This may be false if no such segment exists or if the segment is currently filtered out from view.
See Also Comments