CartoType .NET API 8.8-7-gb35e4dc71
for development in C#, Visual Basic and other .NET languages
Public Member Functions | Properties | List of all members
CartoType::FindParam Class Reference

Parameters for the general Find function. More...

#include <CartoTypeWrapper.h>

Public Member Functions

 FindParam (FindNearbyParam^ aFindNearbyParam)
 Creates a FindParam object from find-nearby parameters.
 

Properties

int MaxObjectCount
 The maximum number of objects to return; default = INT32_MAX.
 
GeometryClip
 The clip path; no clipping is done if Clip is null or empty.
 
GeometryLocation
 The current location. If it is non-empty, objects in or near this region are preferred.
 
String^ Layers
 A list of layer names separated by spaces or commas. If it is null or empty all layers are searched. Layer names may contain the wild cards * and ?.
 
String^ Attributes
 Attributes used in text searching (if Text is not empty). If Attributes is empty, all attributes are searched, otherwise Attributes is a list of attributes separated by spaces or commas; use "$" to indicate the label (the unnamed attribute).
 
String^ Text
 The text to search for. Unless null or empty, restricts the search to objects containing Text in one of their string attributes.
 
StringMatchMethod StringMatchMethod
 The string matching method used for text searching; default = StringMatchExact.
 
String^ Condition
 Unless null or empty, a style sheet condition (e.g., "@sub_type=2") which must be fulfilled by all the objects.
 
bool Merge
 If Merge is true adjoining objects with the same name and attributes may be merged into a single object. The default value is false.
 
double TimeOut
 The maximum time in seconds allowed for a find operation. Find operations are not guaranteed to return in this time or less, but will attempt to do so. A timeout of zero or less means there is no timeout.
 

Detailed Description

Parameters for the general Find function.


The documentation for this class was generated from the following file: