ARCOLBlock Memberss3pi library documentation

The ARCOLBlock type exposes the following members.
Constructors

  NameDescription
Public methodARCOLBlock
Create a new instance based on the data in the supplied Stream.
Back to Top
Methods

  NameDescription
Public methodEquals(Object)
Indicates whether the current ARCOLBlock is equal to another object of the same type.
(Overrides OnlineObject Equals(Object).)
Public methodEquals(ARCOLBlock)
Indicates whether the current ARCOLBlock is equal to another instance.
Public methodGetHashCode
Serves as a hash function for an ARCOLBlock.
(Overrides OnlineObject GetHashCode .)
Protected methodOnRCOLChanged
Used to indicate the RCOL has changed.
Protected methodParse
Any implementation must provide a method of reading data from the resource.
Public methodUnParse
Implementing classes must provide a means of storing themselves in a Stream.
Back to Top
Fields

  NameDescription
Protected fieldrequestedAPIversion
Holds the requested API version.
Protected fieldstream
Holds the stream from which the block was read.
Back to Top
Properties

  NameDescription
Public propertyAsBytes
The resource content as a byte array
Public propertyContentFields
The list of available field names on this API object
(Overrides AApiVersionedFields ContentFields.)
Public propertyData
To allow editor import/export as a minimum.
Public propertyParentTGIBlocks
For ValueBuilder purposes, the list of external resource keys is passed down here. Not all RCOLs need it, so it may end up unused. Override this property to take specific action (such as passing the reference further on).
Public propertyRecommendedApiVersion
Unless overridden in an implementing class, returns 1.
(Overrides AApiVersionedFields RecommendedApiVersion.)
Public propertyResourceType
The Resource Type identifying this block format.
Public propertyStream
The resource content as a Stream
Public propertyTag
The "FOUR CC" tag identifying this RCOL block; may be null if not present.
Protected propertyValueBuilderFields
Remove the additional "banned" fields for an RCOL block.
(Overrides AApiVersionedFields ValueBuilderFields.)
Back to Top
Events

  NameDescription
Public eventResourceChanged
Raised if the resource is changed
Back to Top
See Also