User Tools

Site Tools


thinkgeo.mapsuite.routing.streamloadingeventargs

This is an old revision of the document!


ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs

<!– Class –> This class represents the event arguments for the StreamLoading event.

Remarks

Alternate StreamsWhere 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.

Inheritance Hierarchy

*System.Object System.EventArgs *ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodStreamLoadingEventArgs This is the constructor for the class.
Public MethodStreamLoadingEventArgs String, Stream, FileMode, FileAccess This is the constructor for the class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object

Public Properties

Name Return DeclaringType Summary
Public PropertyAlternateStream Stream This property gets and sets the alternate stream you want to use.
Public PropertyAlternateStreamName String This property gets or sets the source of the stream you wish the user to pass you.
Public PropertyFileAccess FileAccess This property gets and sets the file access that the alternate stream need to function as.
Public PropertyFileMode FileMode This property gets and sets the file mode that the alternate stream need to function as.

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

StreamLoadingEventArgs()

This is the constructor for the class.

Overloads

This is the default constructor taking no arguments which is typically not used.

Remarks

This is the default constructor taking no arguments which is typically not used.Alternate StreamsWhere 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.

Parameters

Name Type Description

Go Back

StreamLoadingEventArgs(String, Stream, FileMode, FileAccess)

This is the constructor for the class.

Overloads

This is the constructor we suggest you you when creating this class.

Remarks

This is the constructor we suggest you you when creating this class.Alternate StreamsWhere 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.

Parameters

Name Type Description
alternateStreamName String<!– System.String –> This parameter represents the key string you will use to find the stream on the client end.
alternateStream Stream<!– System.IO.Stream –> This parameter should be set in the event by the user to represent the alternate stream.
fileMode FileMode<!– System.IO.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.
fileAccess FileAccess<!– System.IO.FileAccess –> This parameter should be set in the event by the user to represent the file access that the alternate stream need to function as.

Go Back

Protected Constructors

Public Methods

Equals(Object)

Remarks

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

ToString()

Remarks

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Public Properties

AlternateStream

This property gets and sets the alternate stream you want to use.

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 StreamsWhere 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.

Return Value

Return Type
Stream<!– System.IO.Stream –>

<!– ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs –> Go Back

AlternateStreamName

This property gets or sets the source of the stream you wish the user to pass you.

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 StreamsWhere 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.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs –> Go Back

FileAccess

This property gets and sets the file access that the alternate stream need to function as.

Remarks

You should set the file access to the mode that best describes the limitations inherent to your alternate stream.Alternate StreamsWhere 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.

Return Value

Return Type
FileAccess<!– System.IO.FileAccess –>

<!– ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs –> Go Back

FileMode

This property gets and sets the file mode that the alternate stream need to function as.

Remarks

You should set the file mode to the mode that best describes the limitations inherent to your alternate stream.Alternate StreamsWhere 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.

Return Value

Return Type
FileMode<!– System.IO.FileMode –>

<!– ThinkGeo.MapSuite.Routing.StreamLoadingEventArgs –> Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.routing.streamloadingeventargs.1440040134.txt.gz · Last modified: 2015/09/18 03:06 (external edit)