M

IsValid

Version comparison

Per-version detail

Click a version below to see what changed in that release vs your current frame (2024).
Identical to 2024: 2020, 2021, 2022, 2023
2024 current
CompoundStructure.IsValid(Document, IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError>, IDictionary<Int32Int32>IDictionary<Int32, Int32>)
doc Document Access to the document in which the CompoundStructure will be used.
errMap IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError> This map will associate each problematic layer index to a value in CompoundStructureError. General structure errors are reported as associated to layer index -1.
twoLayerErrorsMap IDictionary<Int32Int32>IDictionary<Int32, Int32> The map is associated to a check run only for vertically Compound Structures. Essentially the Compound Structure is sliced at representative heights. It looks at the region from exterior to interior, and requires that the assigned layer indices do not decrease. If they do, an entry is generated for this map. The first entry is the last valid layer index encountered. The second entry is a region id whose assigned layer index is too small: it should be at least as large as the first entry.
→ returns Boolean True if the compound structure is valid for the document, false otherwise.
CompoundStructure.IsValid(Document, IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError>, IDictionary<Int32Int32>IDictionary<Int32, Int32>)
doc Document Access to the document in which the CompoundStructure will be used.
errMap IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError> This map will associate each problematic layer index to a value in CompoundStructureError. General structure errors are reported as associated to layer index -1.
twoLayerErrorsMap IDictionary<Int32Int32>IDictionary<Int32, Int32> The map is associated to a check run only for vertically Compound Structures. Essentially the Compound Structure is sliced at representative heights. It looks at the region from exterior to interior, and requires that the assigned layer indices do not decrease. If they do, an entry is generated for this map. The first entry is the last valid layer index encountered. The second entry is a region id whose assigned layer index is too small: it should be at least as large as the first entry.
→ returns Boolean True if the compound structure is valid for the document, false otherwise.
CompoundStructure.IsValid(Document, IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError>, IDictionary<Int32Int32>IDictionary<Int32, Int32>)
doc Document Access to the document in which the CompoundStructure will be used.
errMap IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError> This map will associate each problematic layer index to a value in CompoundStructureError. General structure errors are reported as associated to layer index -1.
twoLayerErrorsMap IDictionary<Int32Int32>IDictionary<Int32, Int32> The map is associated to a check run only for vertically Compound Structures. Essentially the Compound Structure is sliced at representative heights. It looks at the region from exterior to interior, and requires that the assigned layer indices do not decrease. If they do, an entry is generated for this map. The first entry is the last valid layer index encountered. The second entry is a region id whose assigned layer index is too small: it should be at least as large as the first entry.
→ returns Boolean True if the compound structure is valid for the document, false otherwise.
CompoundStructure.IsValid(Document, IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError>, IDictionary<Int32Int32>IDictionary<Int32, Int32>)
doc Document Access to the document in which the CompoundStructure will be used.
errMap IDictionary<Int32CompoundStructureError>IDictionary<Int32, CompoundStructureError> This map will associate each problematic layer index to a value in CompoundStructureError. General structure errors are reported as associated to layer index -1.
twoLayerErrorsMap IDictionary<Int32Int32>IDictionary<Int32, Int32> The map is associated to a check run only for vertically Compound Structures. Essentially the Compound Structure is sliced at representative heights. It looks at the region from exterior to interior, and requires that the assigned layer indices do not decrease. If they do, an entry is generated for this map. The first entry is the last valid layer index encountered. The second entry is a region id whose assigned layer index is too small: it should be at least as large as the first entry.
→ returns Boolean True if the compound structure is valid for the document, false otherwise.