StreamLoadingEventArgs¶
Namespace: ThinkGeo.Core
This class represents the event arguments for the StreamLoading event.
public class StreamLoadingEventArgs : System.EventArgs
Inheritance Object → EventArgs → StreamLoadingEventArgs
Remarks:
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
Properties¶
AlternateStreamName¶
This property gets or sets the source of the stream you wish the user to pass you.
public string AlternateStreamName { get; set; }
Property Value¶
Remarks:
This is always set by the person who created the event arguments and should not be changed by the user.
The streamSource name just needs to be some unique string that will let the user know which file or stream you want. For example you could have a streamSourceName of "Z:\test.shp" and though the Z drive might not exist it might be a cue for you to load "test.shp" from isolated storage. We suggest you use a string that is in the file format of "?:\????.???" as this allows is to validate it though we do not check if it exists.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
AlternateStream¶
This property gets and sets the alternate stream you want to use.
public Stream AlternateStream { get; set; }
Property Value¶
Remarks:
When the event is raised the user should be responsible for either ignoring this property or setting it. It should default to null and if the user wishes to use an alternate stream instead of a file from the disk then they should replace it here.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
FileMode¶
This property gets and sets the file mode that the alternate stream need to function as.
public FileMode FileMode { get; set; }
Property Value¶
Remarks:
You should set the file mode to the mode that best describes the limitations inherent to your alternate stream.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
ReadWriteMode¶
This property gets and sets the file access that the alternate stream need to function as.
public FileAccess ReadWriteMode { get; set; }
Property Value¶
Remarks:
You should set the file access to the mode that best describes the limitations inherent to your alternate stream.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
StreamType¶
This property gets the the stream type you wish the user to pass you. The value represents corresponding stream type: If it is "Image File": it represents you need to pass in a stream represents image file, such as .bmp file stream. If it is "World File": it represents you need to pass in a stream represents world file, such as .bpw file stream. If it is "SHP File": it represents you need to pass in a stream represents .shp file. If it is "SHX File": it represents you need to pass in a stream represents .shx file. If it is "DBF File": it represents you need to pass in a stream represents .dbf file. If it is "DBT File": it represents you need to pass in a stream represents .dbt file. If it is "IDX File": it represents you need to pass in a stream represents .idx file. If it is "IDS File": it represents you need to pass in a stream represents .ids file. If it is "NativeImage": it represents you need to pass in a stream represents NativeImage.
public string StreamType { get; }
Property Value¶
Remarks:
This is always set by the person who created the event arguments and should not be changed by the user.
The streamSource name just needs to be some unique string that will let the user know which file or stream you want. For example you could have a streamSourceName of "Z:\test.shp" and though the Z drive might not exist it might be a cue for you to load "test.shp" from isolated storage. We suggest you use a string that is in the file format of "?:\????.???" as this allows is to validate it though we do not check if it exists.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
Constructors¶
StreamLoadingEventArgs()¶
This is the constructor for the class.
public StreamLoadingEventArgs()
Remarks:
This is the default constructor taking no arguments which is typically not used.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
StreamLoadingEventArgs(String, String)¶
This is the constructor for the class.
public StreamLoadingEventArgs(string alternateStreamName, string streamType)
Parameters¶
alternateStreamName String
This parameter represents the key string you will use to find the stream on the
client end.
streamType String
This parameter represents the stream type string you will use to find the stream on the client end.
Remarks:
This is the default constructor taking no arguments which is typically not used.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
StreamLoadingEventArgs(String, Stream, FileMode, FileAccess)¶
This is the constructor for the class.
public StreamLoadingEventArgs(string alternateStreamName, Stream alternateStream, FileMode fileMode, FileAccess readWriteMode)
Parameters¶
alternateStreamName String
This parameter represents the key string you will use to find the stream on the
client end.
alternateStream Stream
This parameter should be set in the event by the user to represent the alternate
stream.
fileMode FileMode
This parameter should be set in the event by the user to represent the file mode
that the alternate stream need to function as.
readWriteMode FileAccess
Remarks:
This is the constructor we suggest you you when creating this class.
Alternate Streams
Where possible we allow you to use stream in place of concreate files on the file system. This gives you the flexibility to retrieve data from isolated storage, encrypted files, compressed files, fast memory streams or any other stream origin. This is typically available where you would pass in a path and file name. Streams can be substituted in a number of places such as images, shape files etc. Below describes how the system works though specific places may have slightly different variations.
You will create the object that will use the stream normally such as a ShapeFielFeatureSource and then subscribe to the StreamLoading event. For these classes you typically need to supply a path and file name, while this is still required you can pass in a valid path that does not exist such as "Z:\ShapeFile1.shp". When we need the stream from you we will give you this string so you can find the associated stream. In essence you can use the path and file name as a key to kink to the source of your stream.
When we need the file we will raise the StreamLoading event and allow you to pass an alternate stream. In the StreamLoading event we provide you with the path and file name you used and we expect for you to create the stream and set it as the AlternatStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.
StreamLoadingEventArgs(String, String, Stream, FileMode, FileAccess)¶
public StreamLoadingEventArgs(string alternateStreamName, string streamType, Stream alternateStream, FileMode fileMode, FileAccess readWriteMode)
Parameters¶
alternateStreamName String
streamType String
alternateStream Stream
fileMode FileMode
readWriteMode FileAccess