thinkgeo.mapsuite.mapsuitegeocoder.streamloadingeventargs
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mapsuitegeocoder.streamloadingeventargs [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mapsuitegeocoder.streamloadingeventargs [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs ====== | ====== ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class represents the event arguments for the StreamLoading event. | This class represents the event arguments for the StreamLoading event. | ||
| - | === Remarks === | ||
| - | Alternate StreamsWhere possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **System.EventArgs | + | *System.EventArgs |
| - | ***[[ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs]] | + | ***ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} StreamLoadingEventArgs() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#StreamLoadingEventArgs()|StreamLoadingEventArgs]] | | | This is the constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#StreamLoadingEventArgs(String, Stream, FileMode, FileAccess)|StreamLoadingEventArgs]] | String, Stream, FileMode, FileAccess | | This is the constructor for the class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is the constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //This is the default constructor, which takes no arguments. It is typically not used. Alternate Streams Where possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations. You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} StreamLoadingEventArgs(String,Stream,FileMode,FileAccess) ** | ||
| + | * //This is the constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //This is the constructor we suggest you use when creating this class. Alternate Streams Where possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations. You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream.// | ||
| + | == Parameters == | ||
| + | * //alternateStreamName// | ||
| + | * Type:String | ||
| + | * Description:This parameter represents the key string you will use to find the stream on the client end. | ||
| + | |||
| + | * //alternateStream// | ||
| + | * Type:Stream | ||
| + | * Description:This parameter should be set in the event by the user to represent the alternate stream. | ||
| + | |||
| + | * //fileMode// | ||
| + | * Type:FileMode | ||
| + | * Description:This parameter should be set in the event by the user to represent the file mode that the alternate stream needs to function as. | ||
| + | |||
| + | * //fileAccess// | ||
| + | * Type:FileAccess | ||
| + | * Description:This parameter should be set in the event by the user to represent the file access that the alternate stream needs to function as. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //N/A// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#ToString.28.29// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AlternateStream|AlternateStream]] | Stream | | This property gets and sets the alternate stream you want to use. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AlternateStreamName|AlternateStreamName]] | String | | This property gets or sets the source of the stream you wish the user to pass you. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FileAccess|FileAccess]] | FileAccess | | This property gets and sets the file access that the alternate stream needs to function as. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FileMode|FileMode]] | FileMode | | This property gets and sets the file mode that the alternate stream needs to function as. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#Equals.28Object.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== StreamLoadingEventArgs() ==== | + | * Type:Boolean |
| - | This is the constructor for the class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | This is the default constructor, which takes no arguments. It is typically not used. | + | |
| - | === Remarks === | + | |
| - | This is the default constructor, which takes no arguments. It is typically not used.Alternate StreamsWhere possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream 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 ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== StreamLoadingEventArgs(String, Stream, FileMode, FileAccess) ==== | + | * //obj// |
| - | This is the constructor for the class. | + | * Type:Object |
| - | === Overloads === | + | * Description:N/A |
| - | This is the constructor we suggest you use when creating this class. | + | |
| - | === Remarks === | + | |
| - | This is the constructor we suggest you use when creating this class.Alternate StreamsWhere possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream 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 needs 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 needs to function as. | | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ===== Public Methods ===== | + | |
| - | ==== Equals(Object) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#GetHashCode.28.29// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#GetType.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== ToString() ==== | + | ==== Protected Methods ==== |
| - | === Remarks === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#Finalize.28.29// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | ==== Finalize() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#Finalize.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== MemberwiseClone() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#MemberwiseClone.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ===== Public Properties ===== | + | ==== Public Properties ==== |
| - | ==== AlternateStream ==== | + | ** {{wiki:PublicProperty.gif|}} AlternateStreamName ** |
| - | 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 a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream 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.MapSuiteGeocoder.StreamLoadingEventArgs --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== AlternateStreamName ==== | ||
| This property gets or sets the source of the stream you wish the user to pass you. | This property gets or sets the source of the stream you wish the user to pass you. | ||
| - | === Remarks === | + | == 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 clue 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 us to validate it, though we do not check if it actually exists.Alternate StreamsWhere possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream. | + | 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 clue 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 us to validate it, though we do not check if it actually exists. Alternate Streams Where possible, we allow you to use a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations. You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream 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 Value == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs --> | + | ** {{wiki:PublicProperty.gif|}} AlternateStream ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== FileAccess ==== | + | This property gets and sets the alternate stream you want to use. |
| - | This property gets and sets the file access that the alternate stream needs to function as. | + | == Remarks == |
| - | === 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 a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations. You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream. |
| - | 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 a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream 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 Value === | + | * Type:Stream |
| - | ^ Return Type ^ | + | |
| - | | FileAccess<!-- System.IO.FileAccess --> | | + | ** {{wiki:PublicProperty.gif|}} FileMode ** |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== FileMode ==== | ||
| This property gets and sets the file mode that the alternate stream needs to function as. | This property gets and sets the file mode that the alternate stream needs to function as. | ||
| - | === Remarks === | + | == 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 a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations.You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream. | + | 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 a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations. You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream 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 Value == |
| - | ^ Return Type ^ | + | * Type:FileMode |
| - | | FileMode<!-- System.IO.FileMode --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MapSuiteGeocoder.StreamLoadingEventArgs --> | + | ** {{wiki:PublicProperty.gif|}} FileAccess ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | This property gets and sets the file access that the alternate stream needs to function as. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | 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 a stream in place of concrete 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 and so on. We describe how the system works in the following paragraphs, although specific places may have slightly different variations. You will create the object that will use the stream normally, such as a ShapeFileFeatureSource, 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 validly-formatted path that does not actually 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 link 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 AlternateStream property along with setting the FileMode and File access appropriate to the stream. This helps us know our limits with the stream. |
| - | [[Category:MapSuiteGeocoder]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.MapSuiteGeocoder]] | + | * Type:FileAccess |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.mapsuitegeocoder.streamloadingeventargs.1440040131.txt.gz · Last modified: 2015/09/21 07:04 (external edit)