GetRegionWidth Method (GdViewer)
Gets the width of the highlighted region's rectangle, in inches, related to the actual document (meaning the document pages area). The highlighted region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.
You can define the width of the region's rectangle when adding regions using GdViewer.AddRegion or GdViewer.AddRegionInches methods or directly using the GdViewer.SetRegionWidth method.
public float GetRegionWidth(
int
)
public function GetRegionWidth(
: Integer
): Single;
public function GetRegionWidth(
: int
) : float;
public: float GetRegionWidth(
int
)
public:
float GetRegionWidth(
int
)
'Declaration
Public Function GetRegionWidth( _
ByVal As Integer _
) As Single
Parameters
- RegionID
- A unique region identifier of the specified region. You can obtain this identifier using the GdViewer.GetRegionID method or when creating regions using GdViewer.AddRegion or GdViewer.AddRegionInches methods.
Return Value
The width, in inches, of the highlighted region's rectangle, related to the actual document. The
GdViewer.GetStat method can be subsequently used to determine if this method has been successful.
How to use region's coordinates to add new highlighted region.
'We assume that the GdViewer1 control has been properly integrated.
'Please use the multipage document for this example.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
Dim text_to_find As String = "GdPicture"
GdViewer1.RemoveAllRegions()
GdViewer1.DisplayPage(1)
'Determining highlighted regions according to the given text.
Dim text_found As Boolean = GdViewer1.SearchText(text_to_find, 0, True)
If GdViewer1.GetStat() = GdPictureStatus.OK Then
If text_found AndAlso (GdViewer1.RegionCount() > 0) Then
'The first region surely exists.
Dim regID As Integer = GdViewer1.GetRegionID(1)
GdViewer1.SetRegionName(regID, "Region1")
GdViewer1.SetRegionColor(regID, GdViewer1.ARGBI(255, 0, 191, 255))
'Taking properties from the first region.
Dim left As Single = GdViewer1.GetRegionLeft(regID), top As Single = GdViewer1.GetRegionTop(regID)
Dim width As Single = GdViewer1.GetRegionWidth(regID), height As Single = GdViewer1.GetRegionHeight(regID)
For p As Integer = 2 To GdViewer1.PageCount
'Adding regions on the same position on each page as the first one is (with the different color)
'to compare them with those found by the toolkit using the SearchText() method if any exists.
regID = GdViewer1.AddRegionInches("Region" + p.ToString(), left, top, width, height, ForegroundMixMode.ForegroundMixModeMASKPEN, GdViewer1.ARGBI(255, 0, 191, 255))
GdViewer1.SetRegionPage(regID, p)
Next
GdViewer1.Redraw()
'Now you can scroll the viewer to find the newly added regions.
Else
MessageBox.Show("The given text has not been found.", "GdViewer.GetRegionWidth")
End If
Else
MessageBox.Show("The search process has failed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionWidth")
End If
Else
MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionWidth")
End If
//We assume that the GdViewer1 control has been properly integrated.
//Please use the multipage document for this example.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
string text_to_find = "GdPicture";
GdViewer1.RemoveAllRegions();
GdViewer1.DisplayPage(1);
//Determining highlighted regions according to the given text.
bool text_found = GdViewer1.SearchText(text_to_find, 0, true);
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
if (text_found && (GdViewer1.RegionCount()> 0))
{
//The first region surely exists.
int regID = GdViewer1.GetRegionID(1);
GdViewer1.SetRegionName(regID, "Region1");
GdViewer1.SetRegionColor(regID, GdViewer1.ARGBI(255, 0, 191, 255));
//Taking properties from the first region.
float left = GdViewer1.GetRegionLeft(regID), top = GdViewer1.GetRegionTop(regID);
float width = GdViewer1.GetRegionWidth(regID), height = GdViewer1.GetRegionHeight(regID);
for (int p = 2; p <= GdViewer1.PageCount; p++)
{
//Adding regions on the same position on each page as the first one is (with the different color)
//to compare them with those found by the toolkit using the SearchText() method if any exists.
regID = GdViewer1.AddRegionInches("Region" + p.ToString(), left, top, width, height, ForegroundMixMode.ForegroundMixModeMASKPEN, GdViewer1.ARGBI(255, 0, 191, 255));
GdViewer1.SetRegionPage(regID, p);
}
GdViewer1.Redraw();
//Now you can scroll the viewer to find the newly added regions.
}
else
MessageBox.Show("The given text has not been found.", "GdViewer.GetRegionWidth");
}
else
MessageBox.Show("The search process has failed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionWidth");
}
else
MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.GetRegionWidth");
Reference
GdViewer Class
GdViewer Members
SetRegionWidthPixels Method
RegionCount Method
GetRegionID Method
SearchText Method
AddRegion(String,Int32,Int32,Int32,Int32,ForegroundMixMode,Int32) Method
AddRegionInches(String,Single,Single,Single,Single,ForegroundMixMode,Int32) Method
RemoveAllRegions Method
GetRegionWidthPixels Method
SetRegionWidthPixels Method