TElOfficeOpenXMLPackage.OnCreateTemporaryStream event

TElOfficeOpenXMLPackage.OnCreateTemporaryStream

This event is fired when a temporary stream should be created.

Declaration

[C#]
event TSBOfficeCreateTemporaryStreamEvent OnCreateTemporaryStream;
delegate void TSBOfficeCreateTemporaryStreamEvent(Object Sender, ulong ExpectedSize, ref System.IO.Stream Stream, ref bool FreeOnClose);

[VB.NET]
Event OnCreateTemporaryStream As TSBOfficeCreateTemporaryStreamEvent
Delegate Sub TSBOfficeCreateTemporaryStreamEvent(ByVal Sender As Object, ByVal ExpectedSize As Long, ByRef Stream As System.IO.Stream, ByRef FreeOnClose As Boolean)

[Pascal]
property OnCreateTemporaryStream : TSBOfficeCreateTemporaryStreamEvent;
TSBOfficeCreateTemporaryStreamEvent = procedure(Sender : TObject; ExpectedSize : UInt64; var Stream : TStream; var FreeOnClose : boolean) of object;

[C++]
    void get_OnCreateTemporaryStream(TSBOfficeCreateTemporaryStreamEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnCreateTemporaryStream(TSBOfficeCreateTemporaryStreamEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBOfficeCreateTemporaryStreamEvent)(void * _ObjectData, TObjectHandle Sender, uint64_t ExpectedSize, TStreamHandle &Stream, int8_t &FreeOnClose);

[PHP]
    TSBOfficeCreateTemporaryStreamEvent|callable|NULL get_OnCreateTemporaryStream()
    void set_OnCreateTemporaryStream(TSBOfficeCreateTemporaryStreamEvent|callable|NULL $Value)
    callable TSBOfficeCreateTemporaryStreamEvent(TObject $Sender, integer $ExpectedSize, TStream &$Stream, bool &$FreeOnClose)

[Java]
    TSBOfficeCreateTemporaryStreamEvent getOnCreateTemporaryStream();
    void setOnCreateTemporaryStream(TSBOfficeCreateTemporaryStreamEvent Value);
    TSBOfficeCreateTemporaryStreamEvent.Callback OnCreateTemporaryStream = new TSBOfficeCreateTemporaryStreamEvent.Callback() {
        public void TSBOfficeCreateTemporaryStreamEventCallback(TObject arg0, long arg1, TElOfficeCreateTemporaryStreamEventParams arg2) {
            //...
        }
    }

Parameters

ExpectedSize - expected size of the stream
Stream - the stream that is needed
FreeOnClose - set this parameter to True if the stream should be automatically freed

Description

This event is fired by TElOfficeOpenXMLPackage when a temporary stream is needed. The handler should create a stream object and pass it via the Stream parameter. Set FreeOnClose parameter to True if you don't want OnCloseTemporaryStream to be fired on stream closing.