[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

RangeEventArgs

Class RangeEventArgs

java.lang.Object
com.grapecity.documents.excel.EventArgs
com.grapecity.documents.excel.RangeEventArgs
public class RangeEventArgs extends EventArgs
Represents event arguments that contain an IRange object.

RangeEventArgs is used with worksheet-level events such as IWorksheet.getChangedEvent() and IWorksheet.getSelectionChangeEvent(), providing access to the range associated with the event.


 Workbook workbook = new Workbook();
 IWorksheet worksheet = workbook.getActiveSheet();
 final IRange[] rangeFromEvent = {null};
 Event<EventHandler<RangeEventArgs>> changedEvent = worksheet.getChangedEvent();
 changedEvent.addListener(new EventHandler<RangeEventArgs>() {
     public void invoke(Object sender, RangeEventArgs e) {
         rangeFromEvent[0] = e.getRange();
     }
 });
 worksheet.getRange("B2").setValue("Updated");
 IRange changedRange = rangeFromEvent[0];
 Object changedValue = changedRange.getValue();

  • Constructor Details

    • RangeEventArgs

      public RangeEventArgs(IRange range)
      Creates event arguments for the specified range.
      Parameters:
      range - The range associated with the event.

  • Method Details

    • getRange

      public final IRange getRange()
      Gets the range associated with the event. 
      
 Workbook workbook = new Workbook();
 IWorksheet worksheet = workbook.getActiveSheet();
 final IRange[] rangeFromEvent = {null};
 Event<EventHandler<RangeEventArgs>> selectionChangeEvent = worksheet.getSelectionChangeEvent();
 selectionChangeEvent.addListener(new EventHandler<RangeEventArgs>() {
     public void invoke(Object sender, RangeEventArgs e) {
         rangeFromEvent[0] = e.getRange();
     }
 });
 worksheet.getRange("C3:D4").select();
 IRange range = rangeFromEvent[0];
 String selectedAddress = range.toString();
      Returns:
      The event range.